Amazon Lex Model Building V2¶

Description¶

This document provides detailed information about the Amazon Lex V2 API actions and their parameters.

For information about the IAM access control permissions you need to use this API, see Identity-based policies for Amazon Lex V2.

Amazon Lex V2 Model Building V2 operations let you build and manage bots.

If you use a custom HTTP client to call Amazon Lex Model Building V2 operations, you must set the "Content-Type" HTTP header to "application/x-amz-json-1.1". Otherwise, you receive an HTTP 404 - UnknownOperationException in the response.

Amazon Lex Model Building V2 operations return the responses with the "application/x-amz-json-1.1" content type.

You can use Amazon Web Services SDKs to access Amazon Lex V2 APIs using your favorite programming language. The SDKs automatically perform useful tasks for you, such as:

Cryptographically sign your service requests Retry requests Handle error responses

The following resources provide additional information about the Amazon Lex V2 Model Building API.

Amazon Web Services General Reference

Amazon Lex V2 Endpoints for each region.

Command Line Interface

Amazon Lex Model Building V2 CLI commands.

Usage¶

lexmodelsv2(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.
- credentials:
  - creds:
    - access_key_id: AWS access key ID
    - secret_access_key: AWS secret access key
    - session_token: AWS temporary session token
  - profile: The name of a profile to use. If not given, then the default profile is used.
  - anonymous: Set anonymous credentials.
- endpoint: The complete URL to use for the constructed client.
- region: The AWS Region used in instantiating the client.
- close_connection: Immediately close all HTTP connections.
- timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
- s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
- sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
- use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.
credentials

Optional credentials shorthand for the config parameter
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint

Optional shorthand for complete URL to use for the constructed client.
region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- lexmodelsv2(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string",
    use_dual_stack = "logical"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

`batch_create_custom_vocabulary_item`	Create a batch of custom vocabulary items for a given bot locale's custom vocabulary
`batch_delete_custom_vocabulary_item`	Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary
`batch_update_custom_vocabulary_item`	Update a batch of custom vocabulary items for a given bot locale's custom vocabulary
`build_bot_locale`	Builds a bot, its intents, and its slot types into a specific locale
`create_bot`	Creates an Amazon Lex conversational bot
`create_bot_alias`	Creates an alias for the specified version of a bot
`create_bot_locale`	Creates a locale in the bot
`create_bot_replica`	Action to create a replication of the source bot in the secondary region
`create_bot_version`	Creates an immutable version of the bot
`create_export`	Creates a zip archive containing the contents of a bot or a bot locale
`create_intent`	Creates an intent
`create_resource_policy`	Creates a new resource policy with the specified policy statements
`create_resource_policy_statement`	Adds a new resource policy statement to a bot or bot alias
`create_slot`	Creates a slot in an intent
`create_slot_type`	Creates a custom slot type
`create_test_set_discrepancy_report`	Create a report that describes the differences between the bot and the test set
`create_upload_url`	Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale
`delete_bot`	Deletes all versions of a bot, including the Draft version
`delete_bot_alias`	Deletes the specified bot alias
`delete_bot_analyzer_recommendation`	Permanently deletes the recommendations and analysis results for a specific bot analysis request
`delete_bot_locale`	Removes a locale from a bot
`delete_bot_replica`	The action to delete the replicated bot in the secondary region
`delete_bot_version`	Deletes a specific version of a bot
`delete_custom_vocabulary`	Removes a custom vocabulary from the specified locale in the specified bot
`delete_export`	Removes a previous export and the associated files stored in an S3 bucket
`delete_import`	Removes a previous import and the associated file stored in an S3 bucket
`delete_intent`	Removes the specified intent
`delete_resource_policy`	Removes an existing policy from a bot or bot alias
`delete_resource_policy_statement`	Deletes a policy statement from a resource policy
`delete_slot`	Deletes the specified slot from an intent
`delete_slot_type`	Deletes a slot type from a bot locale
`delete_test_set`	The action to delete the selected test set
`delete_utterances`	Deletes stored utterances
`describe_bot`	Provides metadata information about a bot
`describe_bot_alias`	Get information about a specific bot alias
`describe_bot_analyzer_recommendation`	Retrieves the analysis results and recommendations for bot optimization
`describe_bot_locale`	Describes the settings that a bot has for a specific locale
`describe_bot_recommendation`	Provides metadata information about a bot recommendation
`describe_bot_replica`	Monitors the bot replication status through the UI console
`describe_bot_resource_generation`	Returns information about a request to generate a bot through natural language description, made through the StartBotResource API
`describe_bot_version`	Provides metadata about a version of a bot
`describe_custom_vocabulary_metadata`	Provides metadata information about a custom vocabulary
`describe_export`	Gets information about a specific export
`describe_import`	Gets information about a specific import
`describe_intent`	Returns metadata about an intent
`describe_resource_policy`	Gets the resource policy and policy revision for a bot or bot alias
`describe_slot`	Gets metadata information about a slot
`describe_slot_type`	Gets metadata information about a slot type
`describe_test_execution`	Gets metadata information about the test execution
`describe_test_set`	Gets metadata information about the test set
`describe_test_set_discrepancy_report`	Gets metadata information about the test set discrepancy report
`describe_test_set_generation`	Gets metadata information about the test set generation
`generate_bot_element`	Generates sample utterances for an intent
`get_test_execution_artifacts_url`	The pre-signed Amazon S3 URL to download the test execution result artifacts
`list_aggregated_utterances`	Provides a list of utterances that users have sent to the bot
`list_bot_aliases`	Gets a list of aliases for the specified bot
`list_bot_alias_replicas`	The action to list the replicated bots created from the source bot alias
`list_bot_analyzer_history`	Retrieves a list of historical bot analysis executions for a specific bot
`list_bot_locales`	Gets a list of locales for the specified bot
`list_bot_recommendations`	Get a list of bot recommendations that meet the specified criteria
`list_bot_replicas`	The action to list the replicated bots
`list_bot_resource_generations`	Lists the generation requests made for a bot locale
`list_bots`	Gets a list of available bots
`list_bot_version_replicas`	Contains information about all the versions replication statuses applicable for Global Resiliency
`list_bot_versions`	Gets information about all of the versions of a bot
`list_built_in_intents`	Gets a list of built-in intents provided by Amazon Lex that you can use in your bot
`list_built_in_slot_types`	Gets a list of built-in slot types that meet the specified criteria
`list_custom_vocabulary_items`	Paginated list of custom vocabulary items for a given bot locale's custom vocabulary
`list_exports`	Lists the exports for a bot, bot locale, or custom vocabulary
`list_imports`	Lists the imports for a bot, bot locale, or custom vocabulary
`list_intent_metrics`	Retrieves summary metrics for the intents in your bot
`list_intent_paths`	Retrieves summary statistics for a path of intents that users take over sessions with your bot
`list_intents`	Get a list of intents that meet the specified criteria
`list_intent_stage_metrics`	Retrieves summary metrics for the stages within intents in your bot
`list_recommended_intents`	Gets a list of recommended intents provided by the bot recommendation that you can use in your bot
`list_session_analytics_data`	Retrieves a list of metadata for individual user sessions with your bot
`list_session_metrics`	Retrieves summary metrics for the user sessions with your bot
`list_slots`	Gets a list of slots that match the specified criteria
`list_slot_types`	Gets a list of slot types that match the specified criteria
`list_tags_for_resource`	Gets a list of tags associated with a resource
`list_test_execution_result_items`	Gets a list of test execution result items
`list_test_executions`	The list of test set executions
`list_test_set_records`	The list of test set records
`list_test_sets`	The list of the test sets
`list_utterance_analytics_data`	To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics
`list_utterance_metrics`	To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics
`search_associated_transcripts`	Search for associated transcripts that meet the specified criteria
`start_bot_analyzer`	Initiates an asynchronous analysis of your bot configuration using AI-powered analysis to identify potential issues and recommend improvements based on AWS best practices
`start_bot_recommendation`	Use this to provide your transcript data, and to start the bot recommendation process
`start_bot_resource_generation`	Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it
`start_import`	Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket
`start_test_execution`	The action to start test set execution
`start_test_set_generation`	The action to start the generation of test set
`stop_bot_analyzer`	Cancels an ongoing bot analysis execution
`stop_bot_recommendation`	Stop an already running Bot Recommendation request
`tag_resource`	Adds the specified tags to the specified resource
`untag_resource`	Removes tags from a bot, bot alias, or bot channel
`update_bot`	Updates the configuration of an existing bot
`update_bot_alias`	Updates the configuration of an existing bot alias
`update_bot_locale`	Updates the settings that a bot has for a specific locale
`update_bot_recommendation`	Updates an existing bot recommendation request
`update_export`	Updates the password used to protect an export zip archive
`update_intent`	Updates the settings for an intent
`update_resource_policy`	Replaces the existing resource policy for a bot or bot alias with a new one
`update_slot`	Updates the settings for a slot
`update_slot_type`	Updates the configuration of an existing slot type
`update_test_set`	The action to update the test set

Examples¶

svc <- lexmodelsv2()
svc$batch_create_custom_vocabulary_item(
  Foo = 123
)