Struct aws_sdk_lexmodelsv2::client::Client

pub struct Client { /* private fields */ }

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.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_lexmodelsv2::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_lexmodelsv2::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the BatchCreateCustomVocabularyItem operation has a Client::batch_create_custom_vocabulary_item, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.batch_create_custom_vocabulary_item()
    .bot_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations

impl Client

pub fn batch_create_custom_vocabulary_item( &self ) -> BatchCreateCustomVocabularyItemFluentBuilder

Constructs a fluent builder for the BatchCreateCustomVocabularyItem operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot associated with this custom vocabulary.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The identifier of the version of the bot associated with this custom vocabulary.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .

    
    
  • custom_vocabulary_item_list(NewCustomVocabularyItem) / set_custom_vocabulary_item_list(Option<Vec::<NewCustomVocabularyItem>>):
    required: true
    

    A list of new custom vocabulary items. Each entry must contain a phrase and can optionally contain a displayAs and/or a weight.

    
    
• On success, responds with BatchCreateCustomVocabularyItemOutput with field(s):
  • bot_id(Option<String>):

    The identifier of the bot associated with this custom vocabulary.

  • bot_version(Option<String>):

    The identifier of the version of the bot associated with this custom vocabulary.

  • locale_id(Option<String>):

    The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .

  • errors(Option<Vec::<FailedCustomVocabularyItem>>):

    A list of custom vocabulary items that failed to create during the operation. The reason for the error is contained within each error object.

  • resources(Option<Vec::<CustomVocabularyItem>>):

    A list of custom vocabulary items that were successfully created during the operation.

• On failure, responds with SdkError<BatchCreateCustomVocabularyItemError>

impl Client

pub fn batch_delete_custom_vocabulary_item( &self ) -> BatchDeleteCustomVocabularyItemFluentBuilder

Constructs a fluent builder for the BatchDeleteCustomVocabularyItem operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot associated with this custom vocabulary.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The identifier of the version of the bot associated with this custom vocabulary.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .

    
    
  • custom_vocabulary_item_list(CustomVocabularyEntryId) / set_custom_vocabulary_item_list(Option<Vec::<CustomVocabularyEntryId>>):
    required: true
    

    A list of custom vocabulary items requested to be deleted. Each entry must contain the unique custom vocabulary entry identifier.

    
    
• On success, responds with BatchDeleteCustomVocabularyItemOutput with field(s):
  • bot_id(Option<String>):

    The identifier of the bot associated with this custom vocabulary.

  • bot_version(Option<String>):

    The identifier of the version of the bot associated with this custom vocabulary.

  • locale_id(Option<String>):

    The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).

  • errors(Option<Vec::<FailedCustomVocabularyItem>>):

    A list of custom vocabulary items that failed to delete during the operation. The reason for the error is contained within each error object.

  • resources(Option<Vec::<CustomVocabularyItem>>):

    A list of custom vocabulary items that were successfully deleted during the operation.

• On failure, responds with SdkError<BatchDeleteCustomVocabularyItemError>

impl Client

pub fn batch_update_custom_vocabulary_item( &self ) -> BatchUpdateCustomVocabularyItemFluentBuilder

Constructs a fluent builder for the BatchUpdateCustomVocabularyItem operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot associated with this custom vocabulary

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The identifier of the version of the bot associated with this custom vocabulary.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .

    
    
  • custom_vocabulary_item_list(CustomVocabularyItem) / set_custom_vocabulary_item_list(Option<Vec::<CustomVocabularyItem>>):
    required: true
    

    A list of custom vocabulary items with updated fields. Each entry must contain a phrase and can optionally contain a displayAs and/or a weight.

    
    
• On success, responds with BatchUpdateCustomVocabularyItemOutput with field(s):
  • bot_id(Option<String>):

    The identifier of the bot associated with this custom vocabulary.

  • bot_version(Option<String>):

    The identifier of the version of the bot associated with this custom vocabulary.

  • locale_id(Option<String>):

    The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .

  • errors(Option<Vec::<FailedCustomVocabularyItem>>):

    A list of custom vocabulary items that failed to update during the operation. The reason for the error is contained within each error object.

  • resources(Option<Vec::<CustomVocabularyItem>>):

    A list of custom vocabulary items that were successfully updated during the operation.

• On failure, responds with SdkError<BatchUpdateCustomVocabularyItemError>

impl Client

pub fn build_bot_locale(&self) -> BuildBotLocaleFluentBuilder

Constructs a fluent builder for the BuildBotLocale operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

    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 BuildBotLocaleOutput with 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 ReadyExpressTesting you can test the bot using the utterances defined for the intents and slot types. When the status is Built, 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>

impl Client

pub fn create_bot(&self) -> CreateBotFluentBuilder

Constructs a fluent builder for the CreateBot operation.

• The fluent builder is configurable:
  • bot_name(impl Into<String>) / set_bot_name(Option<String>):
    required: true
    

    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>):
    required: false
    

    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>):
    required: true
    

    The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.

    
    
  • data_privacy(DataPrivacy) / set_data_privacy(Option<DataPrivacy>):
    required: true
    

    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>):
    required: true
    

    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(impl Into<String>, impl Into<String>) / set_bot_tags(Option<HashMap::<String, String>>):
    required: false
    

    A list of tags to add to the bot. You can only add tags when you create a bot. You can’t use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

    
    
  • test_bot_alias_tags(impl Into<String>, impl Into<String>) / set_test_bot_alias_tags(Option<HashMap::<String, String>>):
    required: false
    

    A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can’t use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

    
    
  • bot_type(BotType) / set_bot_type(Option<BotType>):
    required: false
    

    The type of a bot to create.

    
    
  • bot_members(BotMember) / set_bot_members(Option<Vec::<BotMember>>):
    required: false
    

    The list of bot members in a network to be created.

    
    
• On success, responds with CreateBotOutput with 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 Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the DRAFT version 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.

  • bot_type(Option<BotType>):

    The type of a bot that was created.

  • bot_members(Option<Vec::<BotMember>>):

    The list of bots in a network that was created.

• On failure, responds with SdkError<CreateBotError>

impl Client

pub fn create_bot_alias(&self) -> CreateBotAliasFluentBuilder

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>):
    required: true
    

    The alias to create. The name must be unique for the bot.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the alias. Use this description to help identify the alias.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: false
    

    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(impl Into<String>, BotAliasLocaleSettings) / set_bot_alias_locale_settings(Option<HashMap::<String, BotAliasLocaleSettings>>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: true
    

    The unique identifier of the bot that the alias applies to.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A list of tags to add to the bot alias. You can only add tags when you create an alias, you can’t use the UpdateBotAlias operation to update the tags on a bot alias. To update tags, use the TagResource operation.

    
    
• On success, responds with CreateBotAliasOutput with 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 Creating state. When the alias is ready to be used, it is put into the Available state. You can use the DescribeBotAlias operation 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>

impl Client

pub fn create_bot_locale(&self) -> CreateBotLocaleFluentBuilder

Constructs a fluent builder for the CreateBotLocale operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot to create the locale for.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: false
    

    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>):
    required: true
    

    Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

    For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the RecognizeText operation would be:

    • AMAZON.FallbackIntent

    • IntentA

    • IntentB

    • IntentC

    
    
  • voice_settings(VoiceSettings) / set_voice_settings(Option<VoiceSettings>):
    required: false
    

    The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

    
    
  • generative_ai_settings(GenerativeAiSettings) / set_generative_ai_settings(Option<GenerativeAiSettings>):
    required: false
    

    Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

    
    
• On success, responds with CreateBotLocaleOutput with 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.FallbackIntent and AMAZON.KendraSearchIntent intents.

  • 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 Creating the bot locale is being configured. When the status is Building Amazon Lex is building the bot for testing and use.

    If the status of the bot is ReadyExpressTesting, you can test the bot using the exact utterances specified in the bots’ intents. When the bot is ready for full testing or to run, the status is Built.

    If there was a problem with building the bot, the status is Failed. If the bot was saved but not built, the status is NotBuilt.

  • creation_date_time(Option<DateTime>):

    A timestamp specifying the date and time that the bot locale was created.

  • generative_ai_settings(Option<GenerativeAiSettings>):

    Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

• On failure, responds with SdkError<CreateBotLocaleError>

impl Client

pub fn create_bot_replica(&self) -> CreateBotReplicaFluentBuilder

Constructs a fluent builder for the CreateBotReplica operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The request for the unique bot ID of the source bot to be replicated in the secondary region.

    
    
  • replica_region(impl Into<String>) / set_replica_region(Option<String>):
    required: true
    

    The request for the secondary region that will be used in the replication of the source bot.

    
    
• On success, responds with CreateBotReplicaOutput with field(s):
  • bot_id(Option<String>):

    The unique bot ID of the replicated bot generated.

  • replica_region(Option<String>):

    The region of the replicated bot generated.

  • source_region(Option<String>):

    The source region for the source bot used for the replicated bot generated.

  • creation_date_time(Option<DateTime>):

    The creation date and time of the replicated bot generated.

  • bot_replica_status(Option<BotReplicaStatus>):

    The operational status of the replicated bot generated.

• On failure, responds with SdkError<CreateBotReplicaError>

impl Client

pub fn create_bot_version(&self) -> CreateBotVersionFluentBuilder

Constructs a fluent builder for the CreateBotVersion operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot to create the version for.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the version. Use the description to help identify the version in lists.

    
    
  • bot_version_locale_specification(impl Into<String>, BotVersionLocaleDetails) / set_bot_version_locale_specification(Option<HashMap::<String, BotVersionLocaleDetails>>):
    required: true
    

    Specifies the locales that Amazon Lex adds to this version. You can choose the Draft version or any other previously published version for each locale. When you specify a source version, the locale data is copied from the source version to the new version.

    
    
• On success, responds with CreateBotVersionOutput with 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 to Available. If Amazon Lex can’t build the bot, it sets status to Failed.

  • creation_date_time(Option<DateTime>):

    A timestamp of the date and time that the version was created.

• On failure, responds with SdkError<CreateBotVersionError>

impl Client

pub fn create_export(&self) -> CreateExportFluentBuilder

Constructs a fluent builder for the CreateExport operation.

• The fluent builder is configurable:
  • resource_specification(ExportResourceSpecification) / set_resource_specification(Option<ExportResourceSpecification>):
    required: true
    

    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>):
    required: true
    

    The file format of the bot or bot locale definition files.

    
    
  • file_password(impl Into<String>) / set_file_password(Option<String>):
    required: false
    

    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 CreateExportOutput with 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>

impl Client

pub fn create_intent(&self) -> CreateIntentFluentBuilder

Constructs a fluent builder for the CreateIntent operation.

• The fluent builder is configurable:
  • intent_name(impl Into<String>) / set_intent_name(Option<String>):
    required: true
    

    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>):
    required: false
    

    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>):
    required: false
    

    A unique identifier for the built-in intent to base this intent on.

    
    
  • sample_utterances(SampleUtterance) / set_sample_utterances(Option<Vec::<SampleUtterance>>):
    required: false
    

    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>):
    required: false
    

    Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction.

    For example, suppose that your bot determines that the user’s name is John. You Lambda function might retrieve John’s information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, glutenIntolerant to true. You might find John’s phone number and set the corresponding session attribute.

    
    
  • fulfillment_code_hook(FulfillmentCodeHookSettings) / set_fulfillment_code_hook(Option<FulfillmentCodeHookSettings>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    Sets the response that Amazon Lex sends to the user when the intent is closed.

    
    
  • input_contexts(InputContext) / set_input_contexts(Option<Vec::<InputContext>>):
    required: false
    

    A list of contexts that must be active for this intent to be considered by Amazon Lex.

    When an intent has an input context list, Amazon Lex only considers using the intent in an interaction with the user when the specified contexts are included in the active context list for the session. If the contexts are not active, then Amazon Lex will not use the intent.

    A context can be automatically activated using the outputContexts property or it can be set at runtime.

    For example, if there are two intents with different input contexts that respond to the same utterances, only the intent with the active context will respond.

    An intent may have up to 5 input contexts. If an intent has multiple input contexts, all of the contexts must be active to consider the intent.

    
    
  • output_contexts(OutputContext) / set_output_contexts(Option<Vec::<OutputContext>>):
    required: false
    

    A lists of contexts that the intent activates when it is fulfilled.

    You can use an output context to indicate the intents that Amazon Lex should consider for the next turn of the conversation with a customer.

    When you use the outputContextsList property, all of the contexts specified in the list are activated when the intent is fulfilled. You can set up to 10 output contexts. You can also set the number of conversation turns that the context should be active, or the length of time that the context should be active.

    
    
  • kendra_configuration(KendraConfiguration) / set_kendra_configuration(Option<KendraConfiguration>):
    required: false
    

    Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. The AMAZON.KendraSearchIntent intent is called when Amazon Lex can’t determine another intent to invoke.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot associated with this intent.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot associated with this intent.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>):
    required: false
    

    Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.

    
    
  • qn_a_intent_configuration(QnAIntentConfiguration) / set_qn_a_intent_configuration(Option<QnAIntentConfiguration>):
    required: false
    

    Specifies the configuration of the built-in Amazon.QnAIntent. The AMAZON.QnAIntent intent is called when Amazon Lex can’t determine another intent to invoke. If you specify this field, you can’t specify the kendraConfiguration field.

    
    
• On success, responds with CreateIntentOutput with 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 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.

  • qn_a_intent_configuration(Option<QnAIntentConfiguration>):

    Details about the the configuration of the built-in Amazon.QnAIntent.

• On failure, responds with SdkError<CreateIntentError>

impl Client

pub fn create_resource_policy(&self) -> CreateResourcePolicyFluentBuilder

Constructs a fluent builder for the CreateResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    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>):
    required: true
    

    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 CreateResourcePolicyOutput with 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>

impl Client

pub fn create_resource_policy_statement( &self ) -> CreateResourcePolicyStatementFluentBuilder

Constructs a fluent builder for the CreateResourcePolicyStatement operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    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>):
    required: true
    

    The name of the statement. The ID is the same as the Sid IAM property. The statement name must be unique within the policy. For more information, see IAM JSON policy elements: Sid.

    
    
  • effect(Effect) / set_effect(Option<Effect>):
    required: true
    

    Determines whether the statement allows or denies access to the resource.

    
    
  • principal(Principal) / set_principal(Option<Vec::<Principal>>):
    required: true
    

    An IAM principal, such as an IAM user, IAM role, or Amazon Web Services services that is allowed or denied access to a resource. For more information, see Amazon Web Services JSON policy elements: Principal.

    
    
  • action(impl Into<String>) / set_action(Option<Vec::<String>>):
    required: true
    

    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(impl Into<String>, HashMap::<String, String>) / set_condition(Option<HashMap::<String, HashMap::<String, String>>>):
    required: false
    

    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>):
    required: false
    

    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 CreateResourcePolicyStatementOutput with 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>

impl Client

pub fn create_slot(&self) -> CreateSlotFluentBuilder

Constructs a fluent builder for the CreateSlot operation.

• The fluent builder is configurable:
  • slot_name(impl Into<String>) / set_slot_name(Option<String>):
    required: true
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: true
    

    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>):
    required: false
    

    Determines how slot values are used in Amazon CloudWatch logs. If the value of the obfuscationSetting parameter is DefaultObfuscation, slot values are obfuscated in the log output. If the value is None, 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>):
    required: true
    

    The identifier of the bot associated with the slot.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot associated with the slot.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    The identifier of the intent that contains the slot.

    
    
  • multiple_values_setting(MultipleValuesSetting) / set_multiple_values_setting(Option<MultipleValuesSetting>):
    required: false
    

    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 true in any other locale, Amazon Lex throws a ValidationException.

    If the multipleValuesSetting is not set, the default value is false.

    
    
  • sub_slot_setting(SubSlotSetting) / set_sub_slot_setting(Option<SubSlotSetting>):
    required: false
    

    Specifications for the constituent sub slots and the expression for the composite slot.

    
    
• On success, responds with CreateSlotOutput with 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>

impl Client

pub fn create_slot_type(&self) -> CreateSlotTypeFluentBuilder

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>):
    required: true
    

    The name for the slot. A slot type name must be unique within the intent.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the slot type. Use the description to help identify the slot type in lists.

    
    
  • slot_type_values(SlotTypeValue) / set_slot_type_values(Option<Vec::<SlotTypeValue>>):
    required: false
    

    A list of SlotTypeValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.

    
    
  • value_selection_setting(SlotValueSelectionSetting) / set_value_selection_setting(Option<SlotValueSelectionSetting>):
    required: false
    

    Determines the strategy that Amazon Lex uses to select a value from the list of possible values. The field can be set to one of the following values:

    • ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value.

    • TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list. If there is no resolution list, return null.

    If you don’t specify the valueSelectionSetting parameter, the default is ORIGINAL_VALUE.

    
    
  • parent_slot_type_signature(impl Into<String>) / set_parent_slot_type_signature(Option<String>):
    required: false
    

    The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type.

    Only AMAZON.AlphaNumeric is supported.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot associated with this slot type.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The identifier of the bot version associated with this slot type.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>):
    required: false
    

    Sets the type of external information used to create the slot type.

    
    
  • composite_slot_type_setting(CompositeSlotTypeSetting) / set_composite_slot_type_setting(Option<CompositeSlotTypeSetting>):
    required: false
    

    Specifications for a composite slot type.

    
    
• On success, responds with CreateSlotTypeOutput with field(s):
  • slot_type_id(Option<String>):

    The unique identifier assigned to the slot type. Use this to identify the slot type in the UpdateSlotType and DeleteSlotType operations.

  • 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>

impl Client

pub fn create_test_set_discrepancy_report( &self ) -> CreateTestSetDiscrepancyReportFluentBuilder

Constructs a fluent builder for the CreateTestSetDiscrepancyReport operation.

• The fluent builder is configurable:
  • test_set_id(impl Into<String>) / set_test_set_id(Option<String>):
    required: true
    

    The test set Id for the test set discrepancy report.

    
    
  • target(TestSetDiscrepancyReportResourceTarget) / set_target(Option<TestSetDiscrepancyReportResourceTarget>):
    required: true
    

    The target bot for the test set discrepancy report.

    
    
• On success, responds with CreateTestSetDiscrepancyReportOutput with field(s):
  • test_set_discrepancy_report_id(Option<String>):

    The unique identifier of the test set discrepancy report to describe.

  • creation_date_time(Option<DateTime>):

    The creation date and time for the test set discrepancy report.

  • test_set_id(Option<String>):

    The test set Id for the test set discrepancy report.

  • target(Option<TestSetDiscrepancyReportResourceTarget>):

    The target bot for the test set discrepancy report.

• On failure, responds with SdkError<CreateTestSetDiscrepancyReportError>

impl Client

pub fn create_upload_url(&self) -> CreateUploadUrlFluentBuilder

Constructs a fluent builder for the CreateUploadUrl operation.

• The fluent builder takes no input, just send it.
• On success, responds with CreateUploadUrlOutput with 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>

impl Client

pub fn delete_bot(&self) -> DeleteBotFluentBuilder

Constructs a fluent builder for the DeleteBot operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot to delete.

    
    
  • skip_resource_in_use_check(bool) / set_skip_resource_in_use_check(Option<bool>):
    required: false
    

    By default, Amazon Lex checks if any other resource, such as an alias or bot network, is using the bot version before it is deleted and throws a ResourceInUseException exception if the bot is being used by another resource. Set this parameter to true to skip this check and remove the bot even if it is being used by another resource.

    
    
• On success, responds with DeleteBotOutput with 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 Deleting while the bot and its associated resources are being deleted.

• On failure, responds with SdkError<DeleteBotError>

impl Client

pub fn delete_bot_alias(&self) -> DeleteBotAliasFluentBuilder

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>):
    required: true
    

    The unique identifier of the bot alias to delete.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot associated with the alias to delete.

    
    
  • skip_resource_in_use_check(bool) / set_skip_resource_in_use_check(Option<bool>):
    required: false
    

    By default, Amazon Lex checks if any other resource, such as a bot network, is using the bot alias before it is deleted and throws a ResourceInUseException exception if the alias is being used by another resource. Set this parameter to true to skip this check and remove the alias even if it is being used by another resource.

    
    
• On success, responds with DeleteBotAliasOutput with 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 Deleting while the alias is in the process of being deleted. Once the alias is deleted, it will no longer appear in the list of aliases returned by the ListBotAliases operation.

• On failure, responds with SdkError<DeleteBotAliasError>

impl Client

pub fn delete_bot_locale(&self) -> DeleteBotLocaleFluentBuilder

Constructs a fluent builder for the DeleteBotLocale operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot that contains the locale.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot that contains the locale.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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 DeleteBotLocaleOutput with 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 Deleting status. Once the locale is deleted it no longer appears in the list of locales for the bot.

• On failure, responds with SdkError<DeleteBotLocaleError>

impl Client

pub fn delete_bot_replica(&self) -> DeleteBotReplicaFluentBuilder

Constructs a fluent builder for the DeleteBotReplica operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique ID of the replicated bot to be deleted from the secondary region

    
    
  • replica_region(impl Into<String>) / set_replica_region(Option<String>):
    required: true
    

    The secondary region of the replicated bot that will be deleted.

    
    
• On success, responds with DeleteBotReplicaOutput with field(s):
  • bot_id(Option<String>):

    The unique bot ID of the replicated bot generated.

  • replica_region(Option<String>):

    The region of the replicated bot generated.

  • bot_replica_status(Option<BotReplicaStatus>):

    The operational status of the replicated bot generated.

• On failure, responds with SdkError<DeleteBotReplicaError>

impl Client

pub fn delete_bot_version(&self) -> DeleteBotVersionFluentBuilder

Constructs a fluent builder for the DeleteBotVersion operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot that contains the version.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot to delete.

    
    
  • skip_resource_in_use_check(bool) / set_skip_resource_in_use_check(Option<bool>):
    required: false
    

    By default, Amazon Lex checks if any other resource, such as an alias or bot network, is using the bot version before it is deleted and throws a ResourceInUseException exception if the version is being used by another resource. Set this parameter to true to skip this check and remove the version even if it is being used by another resource.

    
    
• On success, responds with DeleteBotVersionOutput with 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>

impl Client

pub fn delete_custom_vocabulary(&self) -> DeleteCustomVocabularyFluentBuilder

Constructs a fluent builder for the DeleteCustomVocabulary operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot to remove the custom vocabulary from.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot to remove the custom vocabulary from.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    The locale identifier for the locale that contains the custom vocabulary to remove.

    
    
• On success, responds with DeleteCustomVocabularyOutput with 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>

impl Client

pub fn delete_export(&self) -> DeleteExportFluentBuilder

Constructs a fluent builder for the DeleteExport operation.

• The fluent builder is configurable:
  • export_id(impl Into<String>) / set_export_id(Option<String>):
    required: true
    

    The unique identifier of the export to delete.

    
    
• On success, responds with DeleteExportOutput with 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>

impl Client

pub fn delete_import(&self) -> DeleteImportFluentBuilder

Constructs a fluent builder for the DeleteImport operation.

• The fluent builder is configurable:
  • import_id(impl Into<String>) / set_import_id(Option<String>):
    required: true
    

    The unique identifier of the import to delete.

    
    
• On success, responds with DeleteImportOutput with 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>

impl Client

pub fn delete_intent(&self) -> DeleteIntentFluentBuilder

Constructs a fluent builder for the DeleteIntent operation.

• The fluent builder is configurable:
  • intent_id(impl Into<String>) / set_intent_id(Option<String>):
    required: true
    

    The unique identifier of the intent to delete.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot associated with the intent.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot associated with the intent.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>

impl Client

pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder

Constructs a fluent builder for the DeleteResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    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>):
    required: false
    

    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 DeleteResourcePolicyOutput with 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>

impl Client

pub fn delete_resource_policy_statement( &self ) -> DeleteResourcePolicyStatementFluentBuilder

Constructs a fluent builder for the DeleteResourcePolicyStatement operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    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>):
    required: true
    

    The name of the statement (SID) to delete from the policy.

    
    
  • expected_revision_id(impl Into<String>) / set_expected_revision_id(Option<String>):
    required: false
    

    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 DeleteResourcePolicyStatementOutput with 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>

impl Client

pub fn delete_slot(&self) -> DeleteSlotFluentBuilder

Constructs a fluent builder for the DeleteSlot operation.

• The fluent builder is configurable:
  • slot_id(impl Into<String>) / set_slot_id(Option<String>):
    required: true
    

    The identifier of the slot to delete.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot associated with the slot to delete.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot associated with the slot to delete.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    The identifier of the intent associated with the slot.

    
    
• On success, responds with DeleteSlotOutput
• On failure, responds with SdkError<DeleteSlotError>

impl Client

pub fn delete_slot_type(&self) -> DeleteSlotTypeFluentBuilder

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>):
    required: true
    

    The identifier of the slot type to delete.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot associated with the slot type.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot associated with the slot type.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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(Option<bool>):
    required: false
    

    By default, the DeleteSlotType operations throws a ResourceInUseException exception if you try to delete a slot type used by a slot. Set the skipResourceInUseCheck parameter to true to 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>

impl Client

pub fn delete_test_set(&self) -> DeleteTestSetFluentBuilder

Constructs a fluent builder for the DeleteTestSet operation.

• The fluent builder is configurable:
  • test_set_id(impl Into<String>) / set_test_set_id(Option<String>):
    required: true
    

    The test set Id of the test set to be deleted.

    
    
• On success, responds with DeleteTestSetOutput
• On failure, responds with SdkError<DeleteTestSetError>

impl Client

pub fn delete_utterances(&self) -> DeleteUtterancesFluentBuilder

Constructs a fluent builder for the DeleteUtterances operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot that contains the utterances.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn describe_bot(&self) -> DescribeBotFluentBuilder

Constructs a fluent builder for the DescribeBot operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot to describe.

    
    
• On success, responds with DescribeBotOutput with 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 Available the 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.

  • bot_type(Option<BotType>):

    The type of the bot that was described.

  • bot_members(Option<Vec::<BotMember>>):

    The list of bots in the network that was described.

  • failure_reasons(Option<Vec::<String>>):

    If the botStatus is Failed, this contains a list of reasons that the bot couldn’t be built.

• On failure, responds with SdkError<DescribeBotError>

impl Client

pub fn describe_bot_alias(&self) -> DescribeBotAliasFluentBuilder

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>):
    required: true
    

    The identifier of the bot alias to describe.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot associated with the bot alias to describe.

    
    
• On success, responds with DescribeBotAliasOutput with 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.

  • parent_bot_networks(Option<Vec::<ParentBotNetwork>>):

    A list of the networks to which the bot alias you described belongs.

• On failure, responds with SdkError<DescribeBotAliasError>

impl Client

pub fn describe_bot_locale(&self) -> DescribeBotLocaleFluentBuilder

Constructs a fluent builder for the DescribeBotLocale operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot associated with the locale.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot associated with the locale.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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 DescribeBotLocaleOutput with field(s):
  • bot_id(Option<String>):

    The identifier of the bot associated with the locale.

  • bot_version(Option<String>):

    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.FallbackIntent and AMAZON.KendraSearchIntent intents 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 the failureReasons field.

  • failure_reasons(Option<Vec::<String>>):

    if botLocaleStatus is Failed, 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 failureReasons field.

  • generative_ai_settings(Option<GenerativeAiSettings>):

    Contains settings for Amazon Bedrock’s generative AI features for your bot locale.

• On failure, responds with SdkError<DescribeBotLocaleError>

impl Client

pub fn describe_bot_recommendation( &self ) -> DescribeBotRecommendationFluentBuilder

Constructs a fluent builder for the DescribeBotRecommendation operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot associated with the bot recommendation.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot associated with the bot recommendation.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    The identifier of the bot recommendation to describe.

    
    
• On success, responds with DescribeBotRecommendationOutput with 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>

impl Client

pub fn describe_bot_replica(&self) -> DescribeBotReplicaFluentBuilder

Constructs a fluent builder for the DescribeBotReplica operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The request for the unique bot ID of the replicated bot being monitored.

    
    
  • replica_region(impl Into<String>) / set_replica_region(Option<String>):
    required: true
    

    The request for the region of the replicated bot being monitored.

    
    
• On success, responds with DescribeBotReplicaOutput with field(s):
  • bot_id(Option<String>):

    The unique bot ID of the replicated bot being monitored.

  • replica_region(Option<String>):

    The region of the replicated bot being monitored.

  • source_region(Option<String>):

    The source region of the replicated bot being monitored.

  • creation_date_time(Option<DateTime>):

    The creation date and time of the replicated bot being monitored.

  • bot_replica_status(Option<BotReplicaStatus>):

    The operational status of the replicated bot being monitored.

  • failure_reasons(Option<Vec::<String>>):

    The failure reasons the bot being monitored failed to replicate.

• On failure, responds with SdkError<DescribeBotReplicaError>

impl Client

pub fn describe_bot_resource_generation( &self ) -> DescribeBotResourceGenerationFluentBuilder

Constructs a fluent builder for the DescribeBotResourceGeneration operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot for which to return the generation details.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot for which to return the generation details.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    The locale of the bot for which to return the generation details.

    
    
  • generation_id(impl Into<String>) / set_generation_id(Option<String>):
    required: true
    

    The unique identifier of the generation request for which to return the generation details.

    
    
• On success, responds with DescribeBotResourceGenerationOutput with field(s):
  • bot_id(Option<String>):

    The unique identifier of the bot for which the generation request was made.

  • bot_version(Option<String>):

    The version of the bot for which the generation request was made.

  • locale_id(Option<String>):

    The locale of the bot for which the generation request was made.

  • generation_id(Option<String>):

    The generation ID for which to return the generation details.

  • failure_reasons(Option<Vec::<String>>):

    A list of reasons why the generation of bot resources through natural language description failed.

  • generation_status(Option<GenerationStatus>):

    The status of the generation request.

  • generation_input_prompt(Option<String>):

    The prompt used in the generation request.

  • generated_bot_locale_url(Option<String>):

    The Amazon S3 location of the generated bot locale configuration.

  • creation_date_time(Option<DateTime>):

    The date and time at which the item was generated.

  • model_arn(Option<String>):

    The ARN of the model used to generate the bot resources.

  • last_updated_date_time(Option<DateTime>):

    The date and time at which the generated item was updated.

• On failure, responds with SdkError<DescribeBotResourceGenerationError>

impl Client

pub fn describe_bot_version(&self) -> DescribeBotVersionFluentBuilder

Constructs a fluent builder for the DescribeBotVersion operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot containing the version to return metadata for.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot to return metadata for.

    
    
• On success, responds with DescribeBotVersionOutput with 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 that was described.

  • 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 botStatus is Failed, 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.

  • parent_bot_networks(Option<Vec::<ParentBotNetwork>>):

    A list of the networks to which the bot version you described belongs.

  • bot_type(Option<BotType>):

    The type of the bot in the version that was described.

  • bot_members(Option<Vec::<BotMember>>):

    The members of bot network in the version that was described.

• On failure, responds with SdkError<DescribeBotVersionError>

impl Client

pub fn describe_custom_vocabulary_metadata( &self ) -> DescribeCustomVocabularyMetadataFluentBuilder

Constructs a fluent builder for the DescribeCustomVocabularyMetadata operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot that contains the custom vocabulary.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The bot version of the bot to return metadata for.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    The locale to return the custom vocabulary information for. The locale must be en_GB.

    
    
• On success, responds with DescribeCustomVocabularyMetadataOutput with 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 Ready the 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>

impl Client

pub fn describe_export(&self) -> DescribeExportFluentBuilder

Constructs a fluent builder for the DescribeExport operation.

• The fluent builder is configurable:
  • export_id(impl Into<String>) / set_export_id(Option<String>):
    required: true
    

    The unique identifier of the export to describe.

    
    
• On success, responds with DescribeExportOutput with 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 Complete the export archive file is available for download.

  • failure_reasons(Option<Vec::<String>>):

    If the exportStatus is 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 DescribeExport operation.

  • 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>

impl Client

pub fn describe_import(&self) -> DescribeImportFluentBuilder

Constructs a fluent builder for the DescribeImport operation.

• The fluent builder is configurable:
  • import_id(impl Into<String>) / set_import_id(Option<String>):
    required: true
    

    The unique identifier of the import to describe.

    
    
• On success, responds with DescribeImportOutput with 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 FailOnConflict existing resources are not overwritten and the import fails.

  • import_status(Option<ImportStatus>):

    The status of the import process. When the status is Completed the resource is imported and ready for use.

  • failure_reasons(Option<Vec::<String>>):

    If the importStatus field is Failed, 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>

impl Client

pub fn describe_intent(&self) -> DescribeIntentFluentBuilder

Constructs a fluent builder for the DescribeIntent operation.

• The fluent builder is configurable:
  • intent_id(impl Into<String>) / set_intent_id(Option<String>):
    required: true
    

    The identifier of the intent to describe.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot associated with the intent.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot associated with the intent.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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 DescribeIntentOutput with 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.KendraSearchIntent intent.

  • 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>):

    Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

  • qn_a_intent_configuration(Option<QnAIntentConfiguration>):

    Details about the configuration of the built-in Amazon.QnAIntent.

• On failure, responds with SdkError<DescribeIntentError>

impl Client

pub fn describe_resource_policy(&self) -> DescribeResourcePolicyFluentBuilder

Constructs a fluent builder for the DescribeResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

    
    
• On success, responds with DescribeResourcePolicyOutput with 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>

impl Client

pub fn describe_slot(&self) -> DescribeSlotFluentBuilder

Constructs a fluent builder for the DescribeSlot operation.

• The fluent builder is configurable:
  • slot_id(impl Into<String>) / set_slot_id(Option<String>):
    required: true
    

    The unique identifier for the slot.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot associated with the slot.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot associated with the slot.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    The identifier of the intent that contains the slot.

    
    
• On success, responds with DescribeSlotOutput with 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 multipleValuesSetting is not set, the default value is false.

  • sub_slot_setting(Option<SubSlotSetting>):

    Specifications for the constituent sub slots and the expression for the composite slot.

• On failure, responds with SdkError<DescribeSlotError>

impl Client

pub fn describe_slot_type(&self) -> DescribeSlotTypeFluentBuilder

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>):
    required: true
    

    The identifier of the slot type.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot associated with the slot type.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot associated with the slot type.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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 DescribeSlotTypeOutput with 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>

impl Client

pub fn describe_test_execution(&self) -> DescribeTestExecutionFluentBuilder

Constructs a fluent builder for the DescribeTestExecution operation.

• The fluent builder is configurable:
  • test_execution_id(impl Into<String>) / set_test_execution_id(Option<String>):
    required: true
    

    The execution Id of the test set execution.

    
    
• On success, responds with DescribeTestExecutionOutput with field(s):
  • test_execution_id(Option<String>):

    The execution Id for the test set execution.

  • creation_date_time(Option<DateTime>):

    The execution creation date and time for the test set execution.

  • last_updated_date_time(Option<DateTime>):

    The date and time of the last update for the execution.

  • test_execution_status(Option<TestExecutionStatus>):

    The test execution status for the test execution.

  • test_set_id(Option<String>):

    The test set Id for the test set execution.

  • test_set_name(Option<String>):

    The test set name of the test set execution.

  • target(Option<TestExecutionTarget>):

    The target bot for the test set execution details.

  • api_mode(Option<TestExecutionApiMode>):

    Indicates whether we use streaming or non-streaming APIs are used for the test set execution. For streaming, StartConversation Amazon Lex Runtime API is used. Whereas for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API is used.

  • test_execution_modality(Option<TestExecutionModality>):

    Indicates whether test set is audio or text.

  • failure_reasons(Option<Vec::<String>>):

    Reasons for the failure of the test set execution.

• On failure, responds with SdkError<DescribeTestExecutionError>

impl Client

pub fn describe_test_set(&self) -> DescribeTestSetFluentBuilder

Constructs a fluent builder for the DescribeTestSet operation.

• The fluent builder is configurable:
  • test_set_id(impl Into<String>) / set_test_set_id(Option<String>):
    required: true
    

    The test set Id for the test set request.

    
    
• On success, responds with DescribeTestSetOutput with field(s):
  • test_set_id(Option<String>):

    The test set Id for the test set response.

  • test_set_name(Option<String>):

    The test set name of the test set.

  • description(Option<String>):

    The description of the test set.

  • modality(Option<TestSetModality>):

    Indicates whether the test set is audio or text data.

  • status(Option<TestSetStatus>):

    The status of the test set.

  • role_arn(Option<String>):

    The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.

  • num_turns(Option<i32>):

    The total number of agent and user turn in the test set.

  • storage_location(Option<TestSetStorageLocation>):

    The Amazon S3 storage location for the test set data.

  • creation_date_time(Option<DateTime>):

    The creation date and time for the test set data.

  • last_updated_date_time(Option<DateTime>):

    The date and time for the last update of the test set data.

• On failure, responds with SdkError<DescribeTestSetError>

impl Client

pub fn describe_test_set_discrepancy_report( &self ) -> DescribeTestSetDiscrepancyReportFluentBuilder

Constructs a fluent builder for the DescribeTestSetDiscrepancyReport operation.

• The fluent builder is configurable:
  • test_set_discrepancy_report_id(impl Into<String>) / set_test_set_discrepancy_report_id(Option<String>):
    required: true
    

    The unique identifier of the test set discrepancy report.

    
    
• On success, responds with DescribeTestSetDiscrepancyReportOutput with field(s):
  • test_set_discrepancy_report_id(Option<String>):

    The unique identifier of the test set discrepancy report to describe.

  • test_set_id(Option<String>):

    The test set Id for the test set discrepancy report.

  • creation_date_time(Option<DateTime>):

    The time and date of creation for the test set discrepancy report.

  • target(Option<TestSetDiscrepancyReportResourceTarget>):

    The target bot location for the test set discrepancy report.

  • test_set_discrepancy_report_status(Option<TestSetDiscrepancyReportStatus>):

    The status for the test set discrepancy report.

  • last_updated_data_time(Option<DateTime>):

    The date and time of the last update for the test set discrepancy report.

  • test_set_discrepancy_top_errors(Option<TestSetDiscrepancyErrors>):

    The top 200 error results from the test set discrepancy report.

  • test_set_discrepancy_raw_output_url(Option<String>):

    Pre-signed Amazon S3 URL to download the test set discrepancy report.

  • failure_reasons(Option<Vec::<String>>):

    The failure report for the test set discrepancy report generation action.

• On failure, responds with SdkError<DescribeTestSetDiscrepancyReportError>

impl Client

pub fn describe_test_set_generation( &self ) -> DescribeTestSetGenerationFluentBuilder

Constructs a fluent builder for the DescribeTestSetGeneration operation.

• The fluent builder is configurable:
  • test_set_generation_id(impl Into<String>) / set_test_set_generation_id(Option<String>):
    required: true
    

    The unique identifier of the test set generation.

    
    
• On success, responds with DescribeTestSetGenerationOutput with field(s):
  • test_set_generation_id(Option<String>):

    The unique identifier of the test set generation.

  • test_set_generation_status(Option<TestSetGenerationStatus>):

    The status for the test set generation.

  • failure_reasons(Option<Vec::<String>>):

    The reasons the test set generation failed.

  • test_set_id(Option<String>):

    The unique identifier for the test set created for the generated test set.

  • test_set_name(Option<String>):

    The test set name for the generated test set.

  • description(Option<String>):

    The test set description for the test set generation.

  • storage_location(Option<TestSetStorageLocation>):

    The Amazon S3 storage location for the test set generation.

  • generation_data_source(Option<TestSetGenerationDataSource>):

    The data source of the test set used for the test set generation.

  • role_arn(Option<String>):

    The roleARN of the test set used for the test set generation.

  • creation_date_time(Option<DateTime>):

    The creation date and time for the test set generation.

  • last_updated_date_time(Option<DateTime>):

    The date and time of the last update for the test set generation.

• On failure, responds with SdkError<DescribeTestSetGenerationError>

impl Client

pub fn generate_bot_element(&self) -> GenerateBotElementFluentBuilder

Constructs a fluent builder for the GenerateBotElement operation.

• The fluent builder is configurable:
  • intent_id(impl Into<String>) / set_intent_id(Option<String>):
    required: true
    

    The intent unique Id for the bot request to generate utterances.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The bot unique Id for the bot request to generate utterances.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The bot version for the bot request to generate utterances.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    The unique locale Id for the bot request to generate utterances.

    
    
• On success, responds with GenerateBotElementOutput with field(s):
  • bot_id(Option<String>):

    The unique bot Id for the bot which received the response.

  • bot_version(Option<String>):

    The unique bot version for the bot which received the response.

  • locale_id(Option<String>):

    The unique locale Id for the bot which received the response.

  • intent_id(Option<String>):

    The unique intent Id for the bot which received the response.

  • sample_utterances(Option<Vec::<SampleUtterance>>):

    The sample utterances for the bot which received the response.

• On failure, responds with SdkError<GenerateBotElementError>

impl Client

pub fn get_test_execution_artifacts_url( &self ) -> GetTestExecutionArtifactsUrlFluentBuilder

Constructs a fluent builder for the GetTestExecutionArtifactsUrl operation.

• The fluent builder is configurable:
  • test_execution_id(impl Into<String>) / set_test_execution_id(Option<String>):
    required: true
    

    The unique identifier of the completed test execution.

    
    
• On success, responds with GetTestExecutionArtifactsUrlOutput with field(s):
  • test_execution_id(Option<String>):

    The unique identifier of the completed test execution.

  • download_artifacts_url(Option<String>):

    The pre-signed Amazon S3 URL to download completed test execution.

• On failure, responds with SdkError<GetTestExecutionArtifactsUrlError>

impl Client

pub fn list_aggregated_utterances( &self ) -> ListAggregatedUtterancesFluentBuilder

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>):
    required: true
    

    The unique identifier of the bot associated with this request.

    
    
  • bot_alias_id(impl Into<String>) / set_bot_alias_id(Option<String>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: false
    

    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(AggregatedUtterancesFilter) / set_filters(Option<Vec::<AggregatedUtterancesFilter>>):
    required: false
    

    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>):
    required: false
    

    The maximum number of utterances to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned. If you don’t specify the maxResults parameter, 1,000 results are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the response from the ListAggregatedUtterances operation contains more results that 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 ListAggregatedUtterancesOutput with 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 ListAggregatedUtterances operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListAggregatedUtterances operation request to get the next page of results.

• On failure, responds with SdkError<ListAggregatedUtterancesError>

impl Client

pub fn list_bot_alias_replicas(&self) -> ListBotAliasReplicasFluentBuilder

Constructs a fluent builder for the ListBotAliasReplicas operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The request for the unique bot ID of the replicated bot created from the source bot alias.

    
    
  • replica_region(impl Into<String>) / set_replica_region(Option<String>):
    required: true
    

    The request for the secondary region of the replicated bot created from the source bot alias.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The request for maximum results to list the replicated bots created from the source bot alias.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The request for the next token for the replicated bot created from the source bot alias.

    
    
• On success, responds with ListBotAliasReplicasOutput with field(s):
  • bot_id(Option<String>):

    The unique bot ID of the replicated bot created from the source bot alias.

  • source_region(Option<String>):

    The source region of the replicated bot created from the source bot alias.

  • replica_region(Option<String>):

    The secondary region of the replicated bot created from the source bot alias.

  • bot_alias_replica_summaries(Option<Vec::<BotAliasReplicaSummary>>):

    The summary information of the replicated bot created from the source bot alias.

  • next_token(Option<String>):

    The next token for the replicated bots created from the source bot alias.

• On failure, responds with SdkError<ListBotAliasReplicasError>

impl Client

pub fn list_bot_aliases(&self) -> ListBotAliasesFluentBuilder

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>):
    required: true
    

    The identifier of the bot to list aliases for.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>):
    required: false
    

    If the response from the ListBotAliases 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 ListBotAliasesOutput with 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 maxResults parameter of the request. If there are more aliases 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 ListBotAliases operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation 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>

impl Client

pub fn list_bot_locales(&self) -> ListBotLocalesFluentBuilder

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>):
    required: true
    

    The identifier of the bot to list locales for.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot to list locales for.

    
    
  • sort_by(BotLocaleSortBy) / set_sort_by(Option<BotLocaleSortBy>):
    required: false
    

    Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.

    
    
  • filters(BotLocaleFilter) / set_filters(Option<Vec::<BotLocaleFilter>>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    If the response from the ListBotLocales operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token as the nextToken parameter to return the next page of results.

    
    
• On success, responds with ListBotLocalesOutput with 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 ListBotLocales operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotLocales operation 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 maxResults parameter of the request. If there are more locales available, the nextToken field contains a token to get the next page of results.

• On failure, responds with SdkError<ListBotLocalesError>

impl Client

pub fn list_bot_recommendations(&self) -> ListBotRecommendationsFluentBuilder

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>):
    required: true
    

    The unique identifier of the bot that contains the bot recommendation list.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot that contains the bot recommendation list.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    The identifier of the language and locale of the bot recommendation list.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>):
    required: false
    

    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 ListBotRecommendationsOutput with 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>

impl Client

pub fn list_bot_replicas(&self) -> ListBotReplicasFluentBuilder

Constructs a fluent builder for the ListBotReplicas operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The request for the unique bot IDs in the list of replicated bots.

    
    
• On success, responds with ListBotReplicasOutput with field(s):
  • bot_id(Option<String>):

    the unique bot IDs in the list of replicated bots.

  • source_region(Option<String>):

    The source region of the source bots in the list of replicated bots.

  • bot_replica_summaries(Option<Vec::<BotReplicaSummary>>):

    The summary details for the replicated bots.

• On failure, responds with SdkError<ListBotReplicasError>

impl Client

pub fn list_bot_resource_generations( &self ) -> ListBotResourceGenerationsFluentBuilder

Constructs a fluent builder for the ListBotResourceGenerations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot whose generation requests you want to view.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot whose generation requests you want to view.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    The locale of the bot whose generation requests you want to view.

    
    
  • sort_by(GenerationSortBy) / set_sort_by(Option<GenerationSortBy>):
    required: false
    

    An object containing information about the attribute and the method by which to sort the results

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the total number of results is greater than the number specified in the maxResults, the response returns a token in the nextToken field. Use this token when making a request to return the next batch of results.

    
    
• On success, responds with ListBotResourceGenerationsOutput with field(s):
  • bot_id(Option<String>):

    The unique identifier of the bot for which the generation requests were made.

  • bot_version(Option<String>):

    The version of the bot for which the generation requests were made.

  • locale_id(Option<String>):

    The locale of the bot for which the generation requests were made.

  • generation_summaries(Option<Vec::<GenerationSummary>>):

    A list of objects, each containing information about a generation request for the bot locale.

  • next_token(Option<String>):

    If the total number of results is greater than the number specified in the maxResults, the response returns a token in the nextToken field. Use this token when making a request to return the next batch of results.

• On failure, responds with SdkError<ListBotResourceGenerationsError>

impl Client

pub fn list_bot_version_replicas(&self) -> ListBotVersionReplicasFluentBuilder

Constructs a fluent builder for the ListBotVersionReplicas operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The request for the unique ID in the list of replicated bots.

    
    
  • replica_region(impl Into<String>) / set_replica_region(Option<String>):
    required: true
    

    The request for the region used in the list of replicated bots.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum results given in the list of replicated bots.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The next token given in the list of replicated bots.

    
    
  • sort_by(BotVersionReplicaSortBy) / set_sort_by(Option<BotVersionReplicaSortBy>):
    required: false
    

    The requested sort category for the list of replicated bots.

    
    
• On success, responds with ListBotVersionReplicasOutput with field(s):
  • bot_id(Option<String>):

    The unique ID of the bots in the list of replicated bots.

  • source_region(Option<String>):

    The source region used for the bots in the list of replicated bots.

  • replica_region(Option<String>):

    The region used for the replicated bots in the list of replicated bots.

  • bot_version_replica_summaries(Option<Vec::<BotVersionReplicaSummary>>):

    The information summary used for the replicated bots in the list of replicated bots.

  • next_token(Option<String>):

    The next token used for the replicated bots in the list of replicated bots.

• On failure, responds with SdkError<ListBotVersionReplicasError>

impl Client

pub fn list_bot_versions(&self) -> ListBotVersionsFluentBuilder

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>):
    required: true
    

    The identifier of the bot to list versions for.

    
    
  • sort_by(BotVersionSortBy) / set_sort_by(Option<BotVersionSortBy>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    If the response to the ListBotVersion 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 ListBotVersionsOutput with 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 maxResults parameter of the request. If there are more versions 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 ListBotVersions operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation request to get the next page of results.

• On failure, responds with SdkError<ListBotVersionsError>

impl Client

pub fn list_bots(&self) -> ListBotsFluentBuilder

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>):
    required: false
    

    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(BotFilter) / set_filters(Option<Vec::<BotFilter>>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    If the response from the ListBots operation contains more results than specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a ListBots request to return the next page of results. For a complete set of results, call the ListBots operation until the nextToken returned in the response is null.

    
    
• On success, responds with ListBotsOutput with 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 maxResults parameter of the request. If there are more bots available, the nextToken field 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 ListBots operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBots operation request to get the next page of results.

• On failure, responds with SdkError<ListBotsError>

impl Client

pub fn list_built_in_intents(&self) -> ListBuiltInIntentsFluentBuilder

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>):
    required: true
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    If the response from the ListBuiltInIntents 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 ListBuiltInIntentsOutput with 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 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 ListBuiltInIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation 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>

impl Client

pub fn list_built_in_slot_types(&self) -> ListBuiltInSlotTypesFluentBuilder

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>):
    required: true
    

    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>):
    required: false
    

    Determines the sort order for the response from the ListBuiltInSlotTypes operation. You can choose to sort by the slot type signature in either ascending or descending order.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>):
    required: false
    

    If the response from the ListBuiltInSlotTypes 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 ListBuiltInSlotTypesOutput with 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 maxResults parameter of the request. If there are more slot types 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 ListBuiltInSlotTypes operation. If the nextToken field is present, you send the contents as the nextToken parameter of a LIstBuiltInSlotTypes operation 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>

impl Client

pub fn list_custom_vocabulary_items( &self ) -> ListCustomVocabularyItemsFluentBuilder

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>):
    required: true
    

    The identifier of the version of the bot associated with this custom vocabulary.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The bot version of the bot to the list custom vocabulary request.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items returned by the list operation.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The nextToken identifier to the list custom vocabulary request.

    
    
• On success, responds with ListCustomVocabularyItemsOutput with field(s):
  • bot_id(Option<String>):

    The identifier of the bot associated with this custom vocabulary.

  • bot_version(Option<String>):

    The identifier of the version of the bot associated with this custom vocabulary.

  • locale_id(Option<String>):

    The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .

  • 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>

impl Client

pub fn list_exports(&self) -> ListExportsFluentBuilder

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>):
    required: false
    

    The unique identifier that Amazon Lex assigned to the bot.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: false
    

    The version of the bot to list exports for.

    
    
  • sort_by(ExportSortBy) / set_sort_by(Option<ExportSortBy>):
    required: false
    

    Determines the field that the list of exports is sorted by. You can sort by the LastUpdatedDateTime field in ascending or descending order.

    
    
  • filters(ExportFilter) / set_filters(Option<Vec::<ExportFilter>>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    If the response from the ListExports operation contains more results that specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a ListExports request to return the next page of results. For a complete set of results, call the ListExports operation until the nextToken returned in the response is null.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: false
    

    Specifies the resources that should be exported. If you don’t specify a resource type in the filters parameter, both bot locales and custom vocabularies are exported.

    
    
• On success, responds with ListExportsOutput with 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 maxResults parameter. If there are more exports 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 ListExports operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListExports operation request to get the next page of results.

  • locale_id(Option<String>):

    The locale specified in the request.

• On failure, responds with SdkError<ListExportsError>

impl Client

pub fn list_imports(&self) -> ListImportsFluentBuilder

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>):
    required: false
    

    The unique identifier that Amazon Lex assigned to the bot.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: false
    

    The version of the bot to list imports for.

    
    
  • sort_by(ImportSortBy) / set_sort_by(Option<ImportSortBy>):
    required: false
    

    Determines the field that the list of imports is sorted by. You can sort by the LastUpdatedDateTime field in ascending or descending order.

    
    
  • filters(ImportFilter) / set_filters(Option<Vec::<ImportFilter>>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    If the response from the ListImports operation contains more results than specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a ListImports request to return the next page of results. For a complete set of results, call the ListImports operation until the nextToken returned in the response is null.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: false
    

    Specifies the locale that should be present in the list. If you don’t specify a resource type in the filters parameter, the list contains both bot locales and custom vocabularies.

    
    
• On success, responds with ListImportsOutput with 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 maxResults parameter. If there are more imports 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 ListImports operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListImports operation request to get the next page of results.

  • locale_id(Option<String>):

    The locale specified in the request.

• On failure, responds with SdkError<ListImportsError>

impl Client

pub fn list_intent_metrics(&self) -> ListIntentMetricsFluentBuilder

Constructs a fluent builder for the ListIntentMetrics operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier for the bot for which you want to retrieve intent metrics.

    
    
  • start_date_time(DateTime) / set_start_date_time(Option<DateTime>):
    required: true
    

    The timestamp that marks the beginning of the range of time for which you want to see intent metrics.

    
    
  • end_date_time(DateTime) / set_end_date_time(Option<DateTime>):
    required: true
    

    The date and time that marks the end of the range of time for which you want to see intent metrics.

    
    
  • metrics(AnalyticsIntentMetric) / set_metrics(Option<Vec::<AnalyticsIntentMetric>>):
    required: true
    

    A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the order by which to organize the results.

    
    
  • bin_by(AnalyticsBinBySpecification) / set_bin_by(Option<Vec::<AnalyticsBinBySpecification>>):
    required: false
    

    A list of objects, each of which contains specifications for organizing the results by time.

    
    
  • group_by(AnalyticsIntentGroupBySpecification) / set_group_by(Option<Vec::<AnalyticsIntentGroupBySpecification>>):
    required: false
    

    A list of objects, each of which specifies how to group the results. You can group by the following criteria:

    • IntentName – The name of the intent.

    • IntentEndState – The final state of the intent. The possible end states are detailed in Key definitions in the user guide.

    
    
  • filters(AnalyticsIntentFilter) / set_filters(Option<Vec::<AnalyticsIntentFilter>>):
    required: false
    

    A list of objects, each of which describes a condition by which you want to filter the results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the response from the ListIntentMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a ListIntentMetrics request to return the next page of results. For a complete set of results, call the ListIntentMetrics operation until the nextToken returned in the response is null.

    
    
• On success, responds with ListIntentMetricsOutput with field(s):
  • bot_id(Option<String>):

    The identifier for the bot for which you retrieved intent metrics.

  • results(Option<Vec::<AnalyticsIntentResult>>):

    The results for the intent metrics.

  • next_token(Option<String>):

    If the response from the ListIntentMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a ListIntentMetrics request to return the next page of results. For a complete set of results, call the ListIntentMetrics operation until the nextToken returned in the response is null.

• On failure, responds with SdkError<ListIntentMetricsError>

impl Client

pub fn list_intent_paths(&self) -> ListIntentPathsFluentBuilder

Constructs a fluent builder for the ListIntentPaths operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier for the bot for which you want to retrieve intent path metrics.

    
    
  • start_date_time(DateTime) / set_start_date_time(Option<DateTime>):
    required: true
    

    The date and time that marks the beginning of the range of time for which you want to see intent path metrics.

    
    
  • end_date_time(DateTime) / set_end_date_time(Option<DateTime>):
    required: true
    

    The date and time that marks the end of the range of time for which you want to see intent path metrics.

    
    
  • intent_path(impl Into<String>) / set_intent_path(Option<String>):
    required: true
    

    The intent path for which you want to retrieve metrics. Use a forward slash to separate intents in the path. For example:

    • /BookCar

    • /BookCar/BookHotel

    • /BookHotel/BookCar

    
    
  • filters(AnalyticsPathFilter) / set_filters(Option<Vec::<AnalyticsPathFilter>>):
    required: false
    

    A list of objects, each describes a condition by which you want to filter the results.

    
    
• On success, responds with ListIntentPathsOutput with field(s):
  • node_summaries(Option<Vec::<AnalyticsIntentNodeSummary>>):

    A list of objects, each of which contains information about a node in the intent path for which you requested metrics.

• On failure, responds with SdkError<ListIntentPathsError>

impl Client

pub fn list_intent_stage_metrics(&self) -> ListIntentStageMetricsFluentBuilder

Constructs a fluent builder for the ListIntentStageMetrics operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier for the bot for which you want to retrieve intent stage metrics.

    
    
  • start_date_time(DateTime) / set_start_date_time(Option<DateTime>):
    required: true
    

    The date and time that marks the beginning of the range of time for which you want to see intent stage metrics.

    
    
  • end_date_time(DateTime) / set_end_date_time(Option<DateTime>):
    required: true
    

    The date and time that marks the end of the range of time for which you want to see intent stage metrics.

    
    
  • metrics(AnalyticsIntentStageMetric) / set_metrics(Option<Vec::<AnalyticsIntentStageMetric>>):
    required: true
    

    A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

    
    
  • bin_by(AnalyticsBinBySpecification) / set_bin_by(Option<Vec::<AnalyticsBinBySpecification>>):
    required: false
    

    A list of objects, each of which contains specifications for organizing the results by time.

    
    
  • group_by(AnalyticsIntentStageGroupBySpecification) / set_group_by(Option<Vec::<AnalyticsIntentStageGroupBySpecification>>):
    required: false
    

    A list of objects, each of which specifies how to group the results. You can group by the following criteria:

    • IntentStageName – The name of the intent stage.

    • SwitchedToIntent – The intent to which the conversation was switched (if any).

    
    
  • filters(AnalyticsIntentStageFilter) / set_filters(Option<Vec::<AnalyticsIntentStageFilter>>):
    required: false
    

    A list of objects, each of which describes a condition by which you want to filter the results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the response from the ListIntentStageMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.

    
    
• On success, responds with ListIntentStageMetricsOutput with field(s):
  • bot_id(Option<String>):

    The identifier for the bot for which you retrieved intent stage metrics.

  • results(Option<Vec::<AnalyticsIntentStageResult>>):

    The results for the intent stage metrics.

  • next_token(Option<String>):

    If the response from the ListIntentStageMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.

• On failure, responds with SdkError<ListIntentStageMetricsError>

impl Client

pub fn list_intents(&self) -> ListIntentsFluentBuilder

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>):
    required: true
    

    The unique identifier of the bot that contains the intent.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot that contains the intent.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>):
    required: false
    

    Determines the sort order for the response from the ListIntents operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.

    
    
  • filters(IntentFilter) / set_filters(Option<Vec::<IntentFilter>>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    If the response from the ListIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a ListIntents request to return the next page of results. For a complete set of results, call the ListIntents operation until the nextToken returned in the response is null.

    
    
• On success, responds with ListIntentsOutput with 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 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 ListIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListIntents operation request to get the next page of results.

• On failure, responds with SdkError<ListIntentsError>

impl Client

pub fn list_recommended_intents(&self) -> ListRecommendedIntentsFluentBuilder

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>):
    required: true
    

    The unique identifier of the bot associated with the recommended intents.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot that contains the recommended intents.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    The identifier of the language and locale of the recommended intents.

    
    
  • bot_recommendation_id(impl Into<String>) / set_bot_recommendation_id(Option<String>):
    required: true
    

    The identifier of the bot recommendation that contains the recommended intents.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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>):
    required: false
    

    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 ListRecommendedIntentsOutput with 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>

impl Client

pub fn list_session_analytics_data( &self ) -> ListSessionAnalyticsDataFluentBuilder

Constructs a fluent builder for the ListSessionAnalyticsData operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier for the bot for which you want to retrieve session analytics.

    
    
  • start_date_time(DateTime) / set_start_date_time(Option<DateTime>):
    required: true
    

    The date and time that marks the beginning of the range of time for which you want to see session analytics.

    
    
  • end_date_time(DateTime) / set_end_date_time(Option<DateTime>):
    required: true
    

    The date and time that marks the end of the range of time for which you want to see session analytics.

    
    
  • sort_by(SessionDataSortBy) / set_sort_by(Option<SessionDataSortBy>):
    required: false
    

    An object specifying the measure and method by which to sort the session analytics data.

    
    
  • filters(AnalyticsSessionFilter) / set_filters(Option<Vec::<AnalyticsSessionFilter>>):
    required: false
    

    A list of objects, each of which describes a condition by which you want to filter the results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.

    
    
• On success, responds with ListSessionAnalyticsDataOutput with field(s):
  • bot_id(Option<String>):

    The unique identifier of the bot that the sessions belong to.

  • next_token(Option<String>):

    If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.

  • sessions(Option<Vec::<SessionSpecification>>):

    A list of objects, each of which contains information about a session with the bot.

• On failure, responds with SdkError<ListSessionAnalyticsDataError>

impl Client

pub fn list_session_metrics(&self) -> ListSessionMetricsFluentBuilder

Constructs a fluent builder for the ListSessionMetrics operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier for the bot for which you want to retrieve session metrics.

    
    
  • start_date_time(DateTime) / set_start_date_time(Option<DateTime>):
    required: true
    

    The date and time that marks the beginning of the range of time for which you want to see session metrics.

    
    
  • end_date_time(DateTime) / set_end_date_time(Option<DateTime>):
    required: true
    

    The date and time that marks the end of the range of time for which you want to see session metrics.

    
    
  • metrics(AnalyticsSessionMetric) / set_metrics(Option<Vec::<AnalyticsSessionMetric>>):
    required: true
    

    A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

    
    
  • bin_by(AnalyticsBinBySpecification) / set_bin_by(Option<Vec::<AnalyticsBinBySpecification>>):
    required: false
    

    A list of objects, each of which contains specifications for organizing the results by time.

    
    
  • group_by(AnalyticsSessionGroupBySpecification) / set_group_by(Option<Vec::<AnalyticsSessionGroupBySpecification>>):
    required: false
    

    A list of objects, each of which specifies how to group the results. You can group by the following criteria:

    • ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide.

    • LocaleId – The unique identifier of the bot locale.

    
    
  • filters(AnalyticsSessionFilter) / set_filters(Option<Vec::<AnalyticsSessionFilter>>):
    required: false
    

    A list of objects, each of which describes a condition by which you want to filter the results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.

    
    
• On success, responds with ListSessionMetricsOutput with field(s):
  • bot_id(Option<String>):

    The identifier for the bot for which you retrieved session metrics.

  • results(Option<Vec::<AnalyticsSessionResult>>):

    The results for the session metrics.

  • next_token(Option<String>):

    If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.

• On failure, responds with SdkError<ListSessionMetricsError>

impl Client

pub fn list_slot_types(&self) -> ListSlotTypesFluentBuilder

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>):
    required: true
    

    The unique identifier of the bot that contains the slot types.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot that contains the slot type.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>):
    required: false
    

    Determines the sort order for the response from the ListSlotTypes operation. You can choose to sort by the slot type name or last updated date in either ascending or descending order.

    
    
  • filters(SlotTypeFilter) / set_filters(Option<Vec::<SlotTypeFilter>>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    If the response from the ListSlotTypes 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 ListSlotTypesOutput with 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 maxResults parameter of the request. If there are more slot types 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 ListSlotTypes operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListSlotTypes operation request to get the next page of results.

• On failure, responds with SdkError<ListSlotTypesError>

impl Client

pub fn list_slots(&self) -> ListSlotsFluentBuilder

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>):
    required: true
    

    The identifier of the bot that contains the slot.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot that contains the slot.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    The unique identifier of the intent that contains the slot.

    
    
  • sort_by(SlotSortBy) / set_sort_by(Option<SlotSortBy>):
    required: false
    

    Determines the sort order for the response from the ListSlots operation. You can choose to sort by the slot name or last updated date in either ascending or descending order.

    
    
  • filters(SlotFilter) / set_filters(Option<Vec::<SlotFilter>>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    If the response from the ListSlots 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 ListSlotsOutput with 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 maxResults parameter of the request. If there are more slots 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 ListSlots operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListSlots operation request to get the next page of results.

• On failure, responds with SdkError<ListSlotsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to get a list of tags for.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The tags associated with a resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_test_execution_result_items( &self ) -> ListTestExecutionResultItemsFluentBuilder

Constructs a fluent builder for the ListTestExecutionResultItems operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • test_execution_id(impl Into<String>) / set_test_execution_id(Option<String>):
    required: true
    

    The unique identifier of the test execution to list the result items.

    
    
  • result_filter_by(TestExecutionResultFilterBy) / set_result_filter_by(Option<TestExecutionResultFilterBy>):
    required: true
    

    The filter for the list of results from the test set execution.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of test execution result items to return in each page. If there are fewer results than the max page size, only the actual number of results are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the response from the ListTestExecutionResultItems 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 ListTestExecutionResultItemsOutput with field(s):
  • test_execution_results(Option<TestExecutionResultItems>):

    The list of results from the test execution.

  • next_token(Option<String>):

    A token that indicates whether there are more results to return in a response to the ListTestExecutionResultItems operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestExecutionResultItems operation request to get the next page of results.

• On failure, responds with SdkError<ListTestExecutionResultItemsError>

impl Client

pub fn list_test_executions(&self) -> ListTestExecutionsFluentBuilder

Constructs a fluent builder for the ListTestExecutions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • sort_by(TestExecutionSortBy) / set_sort_by(Option<TestExecutionSortBy>):
    required: false
    

    The sort order of the test set executions.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of test executions to return in each page. If there are fewer results than the max page size, only the actual number of results are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the response from the ListTestExecutions operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

    
    
• On success, responds with ListTestExecutionsOutput with field(s):
  • test_executions(Option<Vec::<TestExecutionSummary>>):

    The list of test executions.

  • next_token(Option<String>):

    A token that indicates whether there are more results to return in a response to the ListTestExecutions operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestExecutions operation request to get the next page of results.

• On failure, responds with SdkError<ListTestExecutionsError>

impl Client

pub fn list_test_set_records(&self) -> ListTestSetRecordsFluentBuilder

Constructs a fluent builder for the ListTestSetRecords operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • test_set_id(impl Into<String>) / set_test_set_id(Option<String>):
    required: true
    

    The identifier of the test set to list its test set records.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of test set records to return in each page. If there are fewer records than the max page size, only the actual number of records are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the response from the ListTestSetRecords operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

    
    
• On success, responds with ListTestSetRecordsOutput with field(s):
  • test_set_records(Option<Vec::<TestSetTurnRecord>>):

    The list of records from the test set.

  • next_token(Option<String>):

    A token that indicates whether there are more records to return in a response to the ListTestSetRecords operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestSetRecords operation request to get the next page of records.

• On failure, responds with SdkError<ListTestSetRecordsError>

impl Client

pub fn list_test_sets(&self) -> ListTestSetsFluentBuilder

Constructs a fluent builder for the ListTestSets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • sort_by(TestSetSortBy) / set_sort_by(Option<TestSetSortBy>):
    required: false
    

    The sort order for the list of test sets.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of test sets to return in each page. If there are fewer results than the max page size, only the actual number of results are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the response from the ListTestSets operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

    
    
• On success, responds with ListTestSetsOutput with field(s):
  • test_sets(Option<Vec::<TestSetSummary>>):

    The selected test sets in a list of test sets.

  • next_token(Option<String>):

    A token that indicates whether there are more results to return in a response to the ListTestSets operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestSets operation request to get the next page of results.

• On failure, responds with SdkError<ListTestSetsError>

impl Client

pub fn list_utterance_analytics_data( &self ) -> ListUtteranceAnalyticsDataFluentBuilder

Constructs a fluent builder for the ListUtteranceAnalyticsData operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier for the bot for which you want to retrieve utterance analytics.

    
    
  • start_date_time(DateTime) / set_start_date_time(Option<DateTime>):
    required: true
    

    The date and time that marks the beginning of the range of time for which you want to see utterance analytics.

    
    
  • end_date_time(DateTime) / set_end_date_time(Option<DateTime>):
    required: true
    

    The date and time that marks the end of the range of time for which you want to see utterance analytics.

    
    
  • sort_by(UtteranceDataSortBy) / set_sort_by(Option<UtteranceDataSortBy>):
    required: false
    

    An object specifying the measure and method by which to sort the utterance analytics data.

    
    
  • filters(AnalyticsUtteranceFilter) / set_filters(Option<Vec::<AnalyticsUtteranceFilter>>):
    required: false
    

    A list of objects, each of which describes a condition by which you want to filter the results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a ListUtteranceAnalyticsData request to return the next page of results. For a complete set of results, call the ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.

    
    
• On success, responds with ListUtteranceAnalyticsDataOutput with field(s):
  • bot_id(Option<String>):

    The unique identifier of the bot that the utterances belong to.

  • next_token(Option<String>):

    If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a ListUtteranceAnalyticsData request to return the next page of results. For a complete set of results, call the ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.

  • utterances(Option<Vec::<UtteranceSpecification>>):

    A list of objects, each of which contains information about an utterance in a user session with your bot.

• On failure, responds with SdkError<ListUtteranceAnalyticsDataError>

impl Client

pub fn list_utterance_metrics(&self) -> ListUtteranceMetricsFluentBuilder

Constructs a fluent builder for the ListUtteranceMetrics operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier for the bot for which you want to retrieve utterance metrics.

    
    
  • start_date_time(DateTime) / set_start_date_time(Option<DateTime>):
    required: true
    

    The date and time that marks the beginning of the range of time for which you want to see utterance metrics.

    
    
  • end_date_time(DateTime) / set_end_date_time(Option<DateTime>):
    required: true
    

    The date and time that marks the end of the range of time for which you want to see utterance metrics.

    
    
  • metrics(AnalyticsUtteranceMetric) / set_metrics(Option<Vec::<AnalyticsUtteranceMetric>>):
    required: true
    

    A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

    
    
  • bin_by(AnalyticsBinBySpecification) / set_bin_by(Option<Vec::<AnalyticsBinBySpecification>>):
    required: false
    

    A list of objects, each of which contains specifications for organizing the results by time.

    
    
  • group_by(AnalyticsUtteranceGroupBySpecification) / set_group_by(Option<Vec::<AnalyticsUtteranceGroupBySpecification>>):
    required: false
    

    A list of objects, each of which specifies how to group the results. You can group by the following criteria:

    • UtteranceText – The transcription of the utterance.

    • UtteranceState – The state of the utterance. The possible states are detailed in Key definitions in the user guide.

    
    
  • attributes(AnalyticsUtteranceAttribute) / set_attributes(Option<Vec::<AnalyticsUtteranceAttribute>>):
    required: false
    

    A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:

    • LastUsedIntent – The last used intent at the time of the utterance.

    
    
  • filters(AnalyticsUtteranceFilter) / set_filters(Option<Vec::<AnalyticsUtteranceFilter>>):
    required: false
    

    A list of objects, each of which describes a condition by which you want to filter the results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.

    
    
• On success, responds with ListUtteranceMetricsOutput with field(s):
  • bot_id(Option<String>):

    The identifier for the bot for which you retrieved utterance metrics.

  • results(Option<Vec::<AnalyticsUtteranceResult>>):

    The results for the utterance metrics.

  • next_token(Option<String>):

    If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.

• On failure, responds with SdkError<ListUtteranceMetricsError>

impl Client

pub fn search_associated_transcripts( &self ) -> SearchAssociatedTranscriptsFluentBuilder

Constructs a fluent builder for the SearchAssociatedTranscripts operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot associated with the transcripts that you are searching.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot containing the transcripts that you are searching.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    The unique identifier of the bot recommendation associated with the transcripts to search.

    
    
  • search_order(SearchOrder) / set_search_order(Option<SearchOrder>):
    required: false
    

    How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

    
    
  • filters(AssociatedTranscriptFilter) / set_filters(Option<Vec::<AssociatedTranscriptFilter>>):
    required: true
    

    A list of filter objects.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>):
    required: false
    

    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 SearchAssociatedTranscriptsOutput with 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>

impl Client

pub fn start_bot_recommendation(&self) -> StartBotRecommendationFluentBuilder

Constructs a fluent builder for the StartBotRecommendation operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot containing the bot recommendation.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot containing the bot recommendation.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

    
    
  • encryption_setting(EncryptionSetting) / set_encryption_setting(Option<EncryptionSetting>):
    required: false
    

    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 StartBotRecommendationOutput with 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>

impl Client

pub fn start_bot_resource_generation( &self ) -> StartBotResourceGenerationFluentBuilder

Constructs a fluent builder for the StartBotResourceGeneration operation.

• The fluent builder is configurable:
  • generation_input_prompt(impl Into<String>) / set_generation_input_prompt(Option<String>):
    required: true
    

    The prompt to generate intents and slot types for the bot locale. Your description should be both detailed and precise to help generate appropriate and sufficient intents for your bot. Include a list of actions to improve the intent creation process.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot for which to generate intents and slot types.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot for which to generate intents and slot types.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    The locale of the bot for which to generate intents and slot types.

    
    
• On success, responds with StartBotResourceGenerationOutput with field(s):
  • generation_input_prompt(Option<String>):

    The prompt that was used generate intents and slot types for the bot locale.

  • generation_id(Option<String>):

    The unique identifier of the generation request.

  • bot_id(Option<String>):

    The unique identifier of the bot for which the generation request was made.

  • bot_version(Option<String>):

    The version of the bot for which the generation request was made.

  • locale_id(Option<String>):

    The locale of the bot for which the generation request was made.

  • generation_status(Option<GenerationStatus>):

    The status of the generation request.

  • creation_date_time(Option<DateTime>):

    The date and time at which the generation request was made.

• On failure, responds with SdkError<StartBotResourceGenerationError>

impl Client

pub fn start_import(&self) -> StartImportFluentBuilder

Constructs a fluent builder for the StartImport operation.

• The fluent builder is configurable:
  • import_id(impl Into<String>) / set_import_id(Option<String>):
    required: true
    

    The unique identifier for the import. It is included in the response from the CreateUploadUrl operation.

    
    
  • resource_specification(ImportResourceSpecification) / set_resource_specification(Option<ImportResourceSpecification>):
    required: true
    

    Parameters for creating the bot, bot locale or custom vocabulary.

    
    
  • merge_strategy(MergeStrategy) / set_merge_strategy(Option<MergeStrategy>):
    required: true
    

    The strategy to use when there is a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.

    
    
  • file_password(impl Into<String>) / set_file_password(Option<String>):
    required: false
    

    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 StartImportOutput with 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 FailOnConflict existing resources are not overwritten and the import fails.

  • import_status(Option<ImportStatus>):

    The current status of the import. When the status is Complete the 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>

impl Client

pub fn start_test_execution(&self) -> StartTestExecutionFluentBuilder

Constructs a fluent builder for the StartTestExecution operation.

• The fluent builder is configurable:
  • test_set_id(impl Into<String>) / set_test_set_id(Option<String>):
    required: true
    

    The test set Id for the test set execution.

    
    
  • target(TestExecutionTarget) / set_target(Option<TestExecutionTarget>):
    required: true
    

    The target bot for the test set execution.

    
    
  • api_mode(TestExecutionApiMode) / set_api_mode(Option<TestExecutionApiMode>):
    required: true
    

    Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Runtime API is used. Whereas, for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.

    
    
  • test_execution_modality(TestExecutionModality) / set_test_execution_modality(Option<TestExecutionModality>):
    required: false
    

    Indicates whether audio or text is used.

    
    
• On success, responds with StartTestExecutionOutput with field(s):
  • test_execution_id(Option<String>):

    The unique identifier of the test set execution.

  • creation_date_time(Option<DateTime>):

    The creation date and time for the test set execution.

  • test_set_id(Option<String>):

    The test set Id for the test set execution.

  • target(Option<TestExecutionTarget>):

    The target bot for the test set execution.

  • api_mode(Option<TestExecutionApiMode>):

    Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Amazon Lex Runtime API is used. Whereas for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.

  • test_execution_modality(Option<TestExecutionModality>):

    Indicates whether audio or text is used.

• On failure, responds with SdkError<StartTestExecutionError>

impl Client

pub fn start_test_set_generation(&self) -> StartTestSetGenerationFluentBuilder

Constructs a fluent builder for the StartTestSetGeneration operation.

• The fluent builder is configurable:
  • test_set_name(impl Into<String>) / set_test_set_name(Option<String>):
    required: true
    

    The test set name for the test set generation request.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The test set description for the test set generation request.

    
    
  • storage_location(TestSetStorageLocation) / set_storage_location(Option<TestSetStorageLocation>):
    required: true
    

    The Amazon S3 storage location for the test set generation.

    
    
  • generation_data_source(TestSetGenerationDataSource) / set_generation_data_source(Option<TestSetGenerationDataSource>):
    required: true
    

    The data source for the test set generation.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.

    
    
  • test_set_tags(impl Into<String>, impl Into<String>) / set_test_set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can’t use the UpdateTestSet operation to update tags. To update tags, use the TagResource operation.

    
    
• On success, responds with StartTestSetGenerationOutput with field(s):
  • test_set_generation_id(Option<String>):

    The unique identifier of the test set generation to describe.

  • creation_date_time(Option<DateTime>):

    The creation date and time for the test set generation.

  • test_set_generation_status(Option<TestSetGenerationStatus>):

    The status for the test set generation.

  • test_set_name(Option<String>):

    The test set name used for the test set generation.

  • description(Option<String>):

    The description used for the test set generation.

  • storage_location(Option<TestSetStorageLocation>):

    The Amazon S3 storage location for the test set generation.

  • generation_data_source(Option<TestSetGenerationDataSource>):

    The data source for the test set generation.

  • role_arn(Option<String>):

    The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.

  • test_set_tags(Option<HashMap::<String, String>>):

    A list of tags that was used for the test set that is being generated.

• On failure, responds with SdkError<StartTestSetGenerationError>

impl Client

pub fn stop_bot_recommendation(&self) -> StopBotRecommendationFluentBuilder

Constructs a fluent builder for the StopBotRecommendation operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot containing the bot recommendation to be stopped.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot containing the bot recommendation.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    The unique identifier of the bot recommendation to be stopped.

    
    
• On success, responds with StopBotRecommendationOutput with 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>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    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>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to remove the tags from.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    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>

impl Client

pub fn update_bot(&self) -> UpdateBotFluentBuilder

Constructs a fluent builder for the UpdateBot operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: false
    

    A description of the bot.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.

    
    
  • data_privacy(DataPrivacy) / set_data_privacy(Option<DataPrivacy>):
    required: true
    

    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>):
    required: true
    

    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_type(BotType) / set_bot_type(Option<BotType>):
    required: false
    

    The type of the bot to be updated.

    
    
  • bot_members(BotMember) / set_bot_members(Option<Vec::<BotMember>>):
    required: false
    

    The list of bot members in the network associated with the update action.

    
    
• On success, responds with UpdateBotOutput with 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 Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the DRAFT version 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.

  • bot_type(Option<BotType>):

    The type of the bot that was updated.

  • bot_members(Option<Vec::<BotMember>>):

    The list of bot members in the network that was updated.

• On failure, responds with SdkError<UpdateBotError>

impl Client

pub fn update_bot_alias(&self) -> UpdateBotAliasFluentBuilder

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>):
    required: true
    

    The unique identifier of the bot alias.

    
    
  • bot_alias_name(impl Into<String>) / set_bot_alias_name(Option<String>):
    required: true
    

    The new name to assign to the bot alias.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The new description to assign to the bot alias.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: false
    

    The new bot version to assign to the bot alias.

    
    
  • bot_alias_locale_settings(impl Into<String>, BotAliasLocaleSettings) / set_bot_alias_locale_settings(Option<HashMap::<String, BotAliasLocaleSettings>>):
    required: false
    

    The new Lambda functions to use in each locale for the bot alias.

    
    
  • conversation_log_settings(ConversationLogSettings) / set_conversation_log_settings(Option<ConversationLogSettings>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: true
    

    The identifier of the bot with the updated alias.

    
    
• On success, responds with UpdateBotAliasOutput with 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 Available the 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>

impl Client

pub fn update_bot_locale(&self) -> UpdateBotLocaleFluentBuilder

Constructs a fluent builder for the UpdateBotLocale operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot that contains the locale.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot that contains the locale to be updated. The version can only be the DRAFT version.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>):
    required: false
    

    The new description of the locale.

    
    
  • nlu_intent_confidence_threshold(f64) / set_nlu_intent_confidence_threshold(Option<f64>):
    required: true
    

    The new confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

    
    
  • voice_settings(VoiceSettings) / set_voice_settings(Option<VoiceSettings>):
    required: false
    

    The new Amazon Polly voice Amazon Lex should use for voice interaction with the user.

    
    
  • generative_ai_settings(GenerativeAiSettings) / set_generative_ai_settings(Option<GenerativeAiSettings>):
    required: false
    

    Contains settings for generative AI features powered by Amazon Bedrock for your bot locale. Use this object to turn generative AI features on and off. Pricing may differ if you turn a feature on. For more information, see LINK.

    
    
• On success, responds with UpdateBotLocaleOutput with 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.FallbackIntent and AMAZON.KendraSearchIntent intents 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 Built the locale is ready for use.

  • failure_reasons(Option<Vec::<String>>):

    If the botLocaleStatus is Failed, the failureReasons field 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 failureReasons field.

  • generative_ai_settings(Option<GenerativeAiSettings>):

    Contains settings for generative AI features powered by Amazon Bedrock for your bot locale.

• On failure, responds with SdkError<UpdateBotLocaleError>

impl Client

pub fn update_bot_recommendation(&self) -> UpdateBotRecommendationFluentBuilder

Constructs a fluent builder for the UpdateBotRecommendation operation.

• The fluent builder is configurable:
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot containing the bot recommendation to be updated.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot containing the bot recommendation to be updated.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    The unique identifier of the bot recommendation to be updated.

    
    
  • encryption_setting(EncryptionSetting) / set_encryption_setting(Option<EncryptionSetting>):
    required: true
    

    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 UpdateBotRecommendationOutput with 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>

impl Client

pub fn update_export(&self) -> UpdateExportFluentBuilder

Constructs a fluent builder for the UpdateExport operation.

• The fluent builder is configurable:
  • export_id(impl Into<String>) / set_export_id(Option<String>):
    required: true
    

    The unique identifier Amazon Lex assigned to the export.

    
    
  • file_password(impl Into<String>) / set_file_password(Option<String>):
    required: false
    

    The new password to use to encrypt the export zip archive.

    
    
• On success, responds with UpdateExportOutput with 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 TSV format is required to export a custom vocabulary only; otherwise use LexJson format.

  • export_status(Option<ExportStatus>):

    The status of the export. When the status is Completed the 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>

impl Client

pub fn update_intent(&self) -> UpdateIntentFluentBuilder

Constructs a fluent builder for the UpdateIntent operation.

• The fluent builder is configurable:
  • intent_id(impl Into<String>) / set_intent_id(Option<String>):
    required: true
    

    The unique identifier of the intent to update.

    
    
  • intent_name(impl Into<String>) / set_intent_name(Option<String>):
    required: true
    

    The new name for the intent.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The new description of the intent.

    
    
  • parent_intent_signature(impl Into<String>) / set_parent_intent_signature(Option<String>):
    required: false
    

    The signature of the new built-in intent to use as the parent of this intent.

    
    
  • sample_utterances(SampleUtterance) / set_sample_utterances(Option<Vec::<SampleUtterance>>):
    required: false
    

    New utterances used to invoke the intent.

    
    
  • dialog_code_hook(DialogCodeHookSettings) / set_dialog_code_hook(Option<DialogCodeHookSettings>):
    required: false
    

    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>):
    required: false
    

    The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.

    
    
  • slot_priorities(SlotPriority) / set_slot_priorities(Option<Vec::<SlotPriority>>):
    required: false
    

    A new list of slots and their priorities that are contained by the intent.

    
    
  • intent_confirmation_setting(IntentConfirmationSetting) / set_intent_confirmation_setting(Option<IntentConfirmationSetting>):
    required: false
    

    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>):
    required: false
    

    The new response that Amazon Lex sends the user when the intent is closed.

    
    
  • input_contexts(InputContext) / set_input_contexts(Option<Vec::<InputContext>>):
    required: false
    

    A new list of contexts that must be active in order for Amazon Lex to consider the intent.

    
    
  • output_contexts(OutputContext) / set_output_contexts(Option<Vec::<OutputContext>>):
    required: false
    

    A new list of contexts that Amazon Lex activates when the intent is fulfilled.

    
    
  • kendra_configuration(KendraConfiguration) / set_kendra_configuration(Option<KendraConfiguration>):
    required: false
    

    New configuration settings for connecting to an Amazon Kendra index.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The identifier of the bot that contains the intent.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot that contains the intent. Must be DRAFT.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>):
    required: false
    

    Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.

    
    
  • qn_a_intent_configuration(QnAIntentConfiguration) / set_qn_a_intent_configuration(Option<QnAIntentConfiguration>):
    required: false
    

    Specifies the configuration of the built-in Amazon.QnAIntent. The AMAZON.QnAIntent intent is called when Amazon Lex can’t determine another intent to invoke. If you specify this field, you can’t specify the kendraConfiguration field.

    
    
• On success, responds with UpdateIntentOutput with 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.KendraSearchIntent intent.

  • 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>):

    Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.

  • qn_a_intent_configuration(Option<QnAIntentConfiguration>):

    Details about the configuration of the built-in Amazon.QnAIntent.

• On failure, responds with SdkError<UpdateIntentError>

impl Client

pub fn update_resource_policy(&self) -> UpdateResourcePolicyFluentBuilder

Constructs a fluent builder for the UpdateResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: false
    

    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 UpdateResourcePolicyOutput with 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>

impl Client

pub fn update_slot(&self) -> UpdateSlotFluentBuilder

Constructs a fluent builder for the UpdateSlot operation.

• The fluent builder is configurable:
  • slot_id(impl Into<String>) / set_slot_id(Option<String>):
    required: true
    

    The unique identifier for the slot to update.

    
    
  • slot_name(impl Into<String>) / set_slot_name(Option<String>):
    required: true
    

    The new name for the slot.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The new description for the slot.

    
    
  • slot_type_id(impl Into<String>) / set_slot_type_id(Option<String>):
    required: false
    

    The unique identifier of the new slot type to associate with this slot.

    
    
  • value_elicitation_setting(SlotValueElicitationSetting) / set_value_elicitation_setting(Option<SlotValueElicitationSetting>):
    required: true
    

    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>):
    required: false
    

    New settings that determine how slot values are formatted in Amazon CloudWatch logs.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot that contains the slot.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot that contains the slot. Must always be DRAFT.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    The identifier of the intent that contains the slot.

    
    
  • multiple_values_setting(MultipleValuesSetting) / set_multiple_values_setting(Option<MultipleValuesSetting>):
    required: false
    

    Determines whether the slot accepts multiple values in one response. Multiple value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.

    If the multipleValuesSetting is not set, the default value is false.

    
    
  • sub_slot_setting(SubSlotSetting) / set_sub_slot_setting(Option<SubSlotSetting>):
    required: false
    

    Specifications for the constituent sub slots and the expression for the composite slot.

    
    
• On success, responds with UpdateSlotOutput with 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 version of the bot 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>

impl Client

pub fn update_slot_type(&self) -> UpdateSlotTypeFluentBuilder

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>):
    required: true
    

    The unique identifier of the slot type to update.

    
    
  • slot_type_name(impl Into<String>) / set_slot_type_name(Option<String>):
    required: true
    

    The new name of the slot type.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The new description of the slot type.

    
    
  • slot_type_values(SlotTypeValue) / set_slot_type_values(Option<Vec::<SlotTypeValue>>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: true
    

    The identifier of the bot that contains the slot type.

    
    
  • bot_version(impl Into<String>) / set_bot_version(Option<String>):
    required: true
    

    The version of the bot that contains the slot type. Must be DRAFT.

    
    
  • locale_id(impl Into<String>) / set_locale_id(Option<String>):
    required: true
    

    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>):
    required: false
    

    Provides information about the external source of the slot type’s definition.

    
    
  • composite_slot_type_setting(CompositeSlotTypeSetting) / set_composite_slot_type_setting(Option<CompositeSlotTypeSetting>):
    required: false
    

    Specifications for a composite slot type.

    
    
• On success, responds with UpdateSlotTypeOutput with 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>

impl Client

pub fn update_test_set(&self) -> UpdateTestSetFluentBuilder

Constructs a fluent builder for the UpdateTestSet operation.

• The fluent builder is configurable:
  • test_set_id(impl Into<String>) / set_test_set_id(Option<String>):
    required: true
    

    The test set Id for which update test operation to be performed.

    
    
  • test_set_name(impl Into<String>) / set_test_set_name(Option<String>):
    required: true
    

    The new test set name.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The new test set description.

    
    
• On success, responds with UpdateTestSetOutput with field(s):
  • test_set_id(Option<String>):

    The test set Id for which update test operation to be performed.

  • test_set_name(Option<String>):

    The test set name for the updated test set.

  • description(Option<String>):

    The test set description for the updated test set.

  • modality(Option<TestSetModality>):

    Indicates whether audio or text is used for the updated test set.

  • status(Option<TestSetStatus>):

    The status for the updated test set.

  • role_arn(Option<String>):

    The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.

  • num_turns(Option<i32>):

    The number of conversation turns from the updated test set.

  • storage_location(Option<TestSetStorageLocation>):

    The Amazon S3 storage location for the updated test set.

  • creation_date_time(Option<DateTime>):

    The creation date and time for the updated test set.

  • last_updated_date_time(Option<DateTime>):

    The date and time of the last update for the updated test set.

• On failure, responds with SdkError<UpdateTestSetError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Waiters for Client

fn wait_until_bot_available(&self) -> BotAvailableFluentBuilder

Wait until a bot is available

fn wait_until_bot_alias_available(&self) -> BotAliasAvailableFluentBuilder

Wait until a bot alias is available

fn wait_until_bot_locale_built(&self) -> BotLocaleBuiltFluentBuilder

Wait until a bot locale is built

fn wait_until_bot_locale_created(&self) -> BotLocaleCreatedFluentBuilder

Wait unit a bot locale is created

fn wait_until_bot_locale_express_testing_available( &self ) -> BotLocaleExpressTestingAvailableFluentBuilder

Wait until a bot locale build is ready for express testing

fn wait_until_bot_version_available(&self) -> BotVersionAvailableFluentBuilder

Wait until a bot version is available

fn wait_until_bot_export_completed(&self) -> BotExportCompletedFluentBuilder

Wait until a bot has been exported

fn wait_until_bot_import_completed(&self) -> BotImportCompletedFluentBuilder

Wait until a bot has been imported