lexmodelsv2 function

Amazon Lex Model Building V2

Amazon Lex Model Building V2

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

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

Returns

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"
  ),
  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_itemCreate a batch of custom vocabulary items for a given bot locale's custom vocabulary
batch_delete_custom_vocabulary_itemDelete a batch of custom vocabulary items for a given bot locale's custom vocabulary
batch_update_custom_vocabulary_itemUpdate a batch of custom vocabulary items for a given bot locale's custom vocabulary
build_bot_localeBuilds a bot, its intents, and its slot types into a specific locale
create_botCreates an Amazon Lex conversational bot
create_bot_aliasCreates an alias for the specified version of a bot
create_bot_localeCreates a locale in the bot
create_bot_replicaAction to create a replication of the source bot in the secondary region
create_bot_versionCreates an immutable version of the bot
create_exportCreates a zip archive containing the contents of a bot or a bot locale
create_intentCreates an intent
create_resource_policyCreates a new resource policy with the specified policy statements
create_resource_policy_statementAdds a new resource policy statement to a bot or bot alias
create_slotCreates a slot in an intent
create_slot_typeCreates a custom slot type
create_test_set_discrepancy_reportCreate a report that describes the differences between the bot and the test set
create_upload_urlGets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale
delete_botDeletes all versions of a bot, including the Draft version
delete_bot_aliasDeletes the specified bot alias
delete_bot_localeRemoves a locale from a bot
delete_bot_replicaThe action to delete the replicated bot in the secondary region
delete_bot_versionDeletes a specific version of a bot
delete_custom_vocabularyRemoves a custom vocabulary from the specified locale in the specified bot
delete_exportRemoves a previous export and the associated files stored in an S3 bucket
delete_importRemoves a previous import and the associated file stored in an S3 bucket
delete_intentRemoves the specified intent
delete_resource_policyRemoves an existing policy from a bot or bot alias
delete_resource_policy_statementDeletes a policy statement from a resource policy
delete_slotDeletes the specified slot from an intent
delete_slot_typeDeletes a slot type from a bot locale
delete_test_setThe action to delete the selected test set
delete_utterancesDeletes stored utterances
describe_botProvides metadata information about a bot
describe_bot_aliasGet information about a specific bot alias
describe_bot_localeDescribes the settings that a bot has for a specific locale
describe_bot_recommendationProvides metadata information about a bot recommendation
describe_bot_replicaMonitors the bot replication status through the UI console
describe_bot_resource_generationReturns information about a request to generate a bot through natural language description, made through the StartBotResource API
describe_bot_versionProvides metadata about a version of a bot
describe_custom_vocabulary_metadataProvides metadata information about a custom vocabulary
describe_exportGets information about a specific export
describe_importGets information about a specific import
describe_intentReturns metadata about an intent
describe_resource_policyGets the resource policy and policy revision for a bot or bot alias
describe_slotGets metadata information about a slot
describe_slot_typeGets metadata information about a slot type
describe_test_executionGets metadata information about the test execution
describe_test_setGets metadata information about the test set
describe_test_set_discrepancy_reportGets metadata information about the test set discrepancy report
describe_test_set_generationGets metadata information about the test set generation
generate_bot_elementGenerates sample utterances for an intent
get_test_execution_artifacts_urlThe pre-signed Amazon S3 URL to download the test execution result artifacts
list_aggregated_utterancesProvides a list of utterances that users have sent to the bot
list_bot_aliasesGets a list of aliases for the specified bot
list_bot_alias_replicasThe action to list the replicated bots created from the source bot alias
list_bot_localesGets a list of locales for the specified bot
list_bot_recommendationsGet a list of bot recommendations that meet the specified criteria
list_bot_replicasThe action to list the replicated bots
list_bot_resource_generationsLists the generation requests made for a bot locale
list_botsGets a list of available bots
list_bot_version_replicasContains information about all the versions replication statuses applicable for Global Resiliency
list_bot_versionsGets information about all of the versions of a bot
list_built_in_intentsGets a list of built-in intents provided by Amazon Lex that you can use in your bot
list_built_in_slot_typesGets a list of built-in slot types that meet the specified criteria
list_custom_vocabulary_itemsPaginated list of custom vocabulary items for a given bot locale's custom vocabulary
list_exportsLists the exports for a bot, bot locale, or custom vocabulary
list_importsLists the imports for a bot, bot locale, or custom vocabulary
list_intent_metricsRetrieves summary metrics for the intents in your bot
list_intent_pathsRetrieves summary statistics for a path of intents that users take over sessions with your bot
list_intentsGet a list of intents that meet the specified criteria
list_intent_stage_metricsRetrieves summary metrics for the stages within intents in your bot
list_recommended_intentsGets a list of recommended intents provided by the bot recommendation that you can use in your bot
list_session_analytics_dataRetrieves a list of metadata for individual user sessions with your bot
list_session_metricsRetrieves summary metrics for the user sessions with your bot
list_slotsGets a list of slots that match the specified criteria
list_slot_typesGets a list of slot types that match the specified criteria
list_tags_for_resourceGets a list of tags associated with a resource
list_test_execution_result_itemsGets a list of test execution result items
list_test_executionsThe list of test set executions
list_test_set_recordsThe list of test set records
list_test_setsThe list of the test sets
list_utterance_analytics_dataTo use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics
list_utterance_metricsTo use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics
search_associated_transcriptsSearch for associated transcripts that meet the specified criteria
start_bot_recommendationUse this to provide your transcript data, and to start the bot recommendation process
start_bot_resource_generationStarts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it
start_importStarts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket
start_test_executionThe action to start test set execution
start_test_set_generationThe action to start the generation of test set
stop_bot_recommendationStop an already running Bot Recommendation request
tag_resourceAdds the specified tags to the specified resource
untag_resourceRemoves tags from a bot, bot alias, or bot channel
update_botUpdates the configuration of an existing bot
update_bot_aliasUpdates the configuration of an existing bot alias
update_bot_localeUpdates the settings that a bot has for a specific locale
update_bot_recommendationUpdates an existing bot recommendation request
update_exportUpdates the password used to protect an export zip archive
update_intentUpdates the settings for an intent
update_resource_policyReplaces the existing resource policy for a bot or bot alias with a new one
update_slotUpdates the settings for a slot
update_slot_typeUpdates the configuration of an existing slot type
update_test_setThe action to update the test set

Examples

## Not run: svc <- lexmodelsv2() svc$batch_create_custom_vocabulary_item( Foo = 123 ) ## End(Not run)
  • Maintainer: Dyfan Jones
  • License: Apache License (>= 2.0)
  • Last published: 2025-03-17