Class: Aws::LexModelsV2::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::LexModelsV2::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb
Overview
An API client for LexModelsV2. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::LexModelsV2::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_create_custom_vocabulary_item(params = {}) ⇒ Types::BatchCreateCustomVocabularyItemResponse
Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.
-
#batch_delete_custom_vocabulary_item(params = {}) ⇒ Types::BatchDeleteCustomVocabularyItemResponse
Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.
-
#batch_update_custom_vocabulary_item(params = {}) ⇒ Types::BatchUpdateCustomVocabularyItemResponse
Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.
-
#build_bot_locale(params = {}) ⇒ Types::BuildBotLocaleResponse
Builds a bot, its intents, and its slot types into a specific locale.
-
#create_bot(params = {}) ⇒ Types::CreateBotResponse
Creates an Amazon Lex conversational bot.
-
#create_bot_alias(params = {}) ⇒ Types::CreateBotAliasResponse
Creates an alias for the specified version of a bot.
-
#create_bot_locale(params = {}) ⇒ Types::CreateBotLocaleResponse
Creates a locale in the bot.
-
#create_bot_replica(params = {}) ⇒ Types::CreateBotReplicaResponse
Action to create a replication of the source bot in the secondary region.
-
#create_bot_version(params = {}) ⇒ Types::CreateBotVersionResponse
Creates an immutable version of the bot.
-
#create_export(params = {}) ⇒ Types::CreateExportResponse
Creates a zip archive containing the contents of a bot or a bot locale.
-
#create_intent(params = {}) ⇒ Types::CreateIntentResponse
Creates an intent.
-
#create_resource_policy(params = {}) ⇒ Types::CreateResourcePolicyResponse
Creates a new resource policy with the specified policy statements.
-
#create_resource_policy_statement(params = {}) ⇒ Types::CreateResourcePolicyStatementResponse
Adds a new resource policy statement to a bot or bot alias.
-
#create_slot(params = {}) ⇒ Types::CreateSlotResponse
Creates a slot in an intent.
-
#create_slot_type(params = {}) ⇒ Types::CreateSlotTypeResponse
Creates a custom slot type.
-
#create_test_set_discrepancy_report(params = {}) ⇒ Types::CreateTestSetDiscrepancyReportResponse
Create a report that describes the differences between the bot and the test set.
-
#create_upload_url(params = {}) ⇒ Types::CreateUploadUrlResponse
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(params = {}) ⇒ Types::DeleteBotResponse
Deletes all versions of a bot, including the
Draft
version. -
#delete_bot_alias(params = {}) ⇒ Types::DeleteBotAliasResponse
Deletes the specified bot alias.
-
#delete_bot_locale(params = {}) ⇒ Types::DeleteBotLocaleResponse
Removes a locale from a bot.
-
#delete_bot_replica(params = {}) ⇒ Types::DeleteBotReplicaResponse
The action to delete the replicated bot in the secondary region.
-
#delete_bot_version(params = {}) ⇒ Types::DeleteBotVersionResponse
Deletes a specific version of a bot.
-
#delete_custom_vocabulary(params = {}) ⇒ Types::DeleteCustomVocabularyResponse
Removes a custom vocabulary from the specified locale in the specified bot.
-
#delete_export(params = {}) ⇒ Types::DeleteExportResponse
Removes a previous export and the associated files stored in an S3 bucket.
-
#delete_import(params = {}) ⇒ Types::DeleteImportResponse
Removes a previous import and the associated file stored in an S3 bucket.
-
#delete_intent(params = {}) ⇒ Struct
Removes the specified intent.
-
#delete_resource_policy(params = {}) ⇒ Types::DeleteResourcePolicyResponse
Removes an existing policy from a bot or bot alias.
-
#delete_resource_policy_statement(params = {}) ⇒ Types::DeleteResourcePolicyStatementResponse
Deletes a policy statement from a resource policy.
-
#delete_slot(params = {}) ⇒ Struct
Deletes the specified slot from an intent.
-
#delete_slot_type(params = {}) ⇒ Struct
Deletes a slot type from a bot locale.
-
#delete_test_set(params = {}) ⇒ Struct
The action to delete the selected test set.
-
#delete_utterances(params = {}) ⇒ Struct
Deletes stored utterances.
-
#describe_bot(params = {}) ⇒ Types::DescribeBotResponse
Provides metadata information about a bot.
-
#describe_bot_alias(params = {}) ⇒ Types::DescribeBotAliasResponse
Get information about a specific bot alias.
-
#describe_bot_locale(params = {}) ⇒ Types::DescribeBotLocaleResponse
Describes the settings that a bot has for a specific locale.
-
#describe_bot_recommendation(params = {}) ⇒ Types::DescribeBotRecommendationResponse
Provides metadata information about a bot recommendation.
-
#describe_bot_replica(params = {}) ⇒ Types::DescribeBotReplicaResponse
Monitors the bot replication status through the UI console.
-
#describe_bot_resource_generation(params = {}) ⇒ Types::DescribeBotResourceGenerationResponse
Returns information about a request to generate a bot through natural language description, made through the
StartBotResource
API. -
#describe_bot_version(params = {}) ⇒ Types::DescribeBotVersionResponse
Provides metadata about a version of a bot.
-
#describe_custom_vocabulary_metadata(params = {}) ⇒ Types::DescribeCustomVocabularyMetadataResponse
Provides metadata information about a custom vocabulary.
-
#describe_export(params = {}) ⇒ Types::DescribeExportResponse
Gets information about a specific export.
-
#describe_import(params = {}) ⇒ Types::DescribeImportResponse
Gets information about a specific import.
-
#describe_intent(params = {}) ⇒ Types::DescribeIntentResponse
Returns metadata about an intent.
-
#describe_resource_policy(params = {}) ⇒ Types::DescribeResourcePolicyResponse
Gets the resource policy and policy revision for a bot or bot alias.
-
#describe_slot(params = {}) ⇒ Types::DescribeSlotResponse
Gets metadata information about a slot.
-
#describe_slot_type(params = {}) ⇒ Types::DescribeSlotTypeResponse
Gets metadata information about a slot type.
-
#describe_test_execution(params = {}) ⇒ Types::DescribeTestExecutionResponse
Gets metadata information about the test execution.
-
#describe_test_set(params = {}) ⇒ Types::DescribeTestSetResponse
Gets metadata information about the test set.
-
#describe_test_set_discrepancy_report(params = {}) ⇒ Types::DescribeTestSetDiscrepancyReportResponse
Gets metadata information about the test set discrepancy report.
-
#describe_test_set_generation(params = {}) ⇒ Types::DescribeTestSetGenerationResponse
Gets metadata information about the test set generation.
-
#generate_bot_element(params = {}) ⇒ Types::GenerateBotElementResponse
Generates sample utterances for an intent.
-
#get_test_execution_artifacts_url(params = {}) ⇒ Types::GetTestExecutionArtifactsUrlResponse
The pre-signed Amazon S3 URL to download the test execution result artifacts.
-
#list_aggregated_utterances(params = {}) ⇒ Types::ListAggregatedUtterancesResponse
Provides a list of utterances that users have sent to the bot.
-
#list_bot_alias_replicas(params = {}) ⇒ Types::ListBotAliasReplicasResponse
The action to list the replicated bots created from the source bot alias.
-
#list_bot_aliases(params = {}) ⇒ Types::ListBotAliasesResponse
Gets a list of aliases for the specified bot.
-
#list_bot_locales(params = {}) ⇒ Types::ListBotLocalesResponse
Gets a list of locales for the specified bot.
-
#list_bot_recommendations(params = {}) ⇒ Types::ListBotRecommendationsResponse
Get a list of bot recommendations that meet the specified criteria.
-
#list_bot_replicas(params = {}) ⇒ Types::ListBotReplicasResponse
The action to list the replicated bots.
-
#list_bot_resource_generations(params = {}) ⇒ Types::ListBotResourceGenerationsResponse
Lists the generation requests made for a bot locale.
-
#list_bot_version_replicas(params = {}) ⇒ Types::ListBotVersionReplicasResponse
Contains information about all the versions replication statuses applicable for Global Resiliency.
-
#list_bot_versions(params = {}) ⇒ Types::ListBotVersionsResponse
Gets information about all of the versions of a bot.
-
#list_bots(params = {}) ⇒ Types::ListBotsResponse
Gets a list of available bots.
-
#list_built_in_intents(params = {}) ⇒ Types::ListBuiltInIntentsResponse
Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.
-
#list_built_in_slot_types(params = {}) ⇒ Types::ListBuiltInSlotTypesResponse
Gets a list of built-in slot types that meet the specified criteria.
-
#list_custom_vocabulary_items(params = {}) ⇒ Types::ListCustomVocabularyItemsResponse
Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.
-
#list_exports(params = {}) ⇒ Types::ListExportsResponse
Lists the exports for a bot, bot locale, or custom vocabulary.
-
#list_imports(params = {}) ⇒ Types::ListImportsResponse
Lists the imports for a bot, bot locale, or custom vocabulary.
-
#list_intent_metrics(params = {}) ⇒ Types::ListIntentMetricsResponse
Retrieves summary metrics for the intents in your bot.
-
#list_intent_paths(params = {}) ⇒ Types::ListIntentPathsResponse
Retrieves summary statistics for a path of intents that users take over sessions with your bot.
-
#list_intent_stage_metrics(params = {}) ⇒ Types::ListIntentStageMetricsResponse
Retrieves summary metrics for the stages within intents in your bot.
-
#list_intents(params = {}) ⇒ Types::ListIntentsResponse
Get a list of intents that meet the specified criteria.
-
#list_recommended_intents(params = {}) ⇒ Types::ListRecommendedIntentsResponse
Gets a list of recommended intents provided by the bot recommendation that you can use in your bot.
-
#list_session_analytics_data(params = {}) ⇒ Types::ListSessionAnalyticsDataResponse
Retrieves a list of metadata for individual user sessions with your bot.
-
#list_session_metrics(params = {}) ⇒ Types::ListSessionMetricsResponse
Retrieves summary metrics for the user sessions with your bot.
-
#list_slot_types(params = {}) ⇒ Types::ListSlotTypesResponse
Gets a list of slot types that match the specified criteria.
-
#list_slots(params = {}) ⇒ Types::ListSlotsResponse
Gets a list of slots that match the specified criteria.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets a list of tags associated with a resource.
-
#list_test_execution_result_items(params = {}) ⇒ Types::ListTestExecutionResultItemsResponse
Gets a list of test execution result items.
-
#list_test_executions(params = {}) ⇒ Types::ListTestExecutionsResponse
The list of test set executions.
-
#list_test_set_records(params = {}) ⇒ Types::ListTestSetRecordsResponse
The list of test set records.
-
#list_test_sets(params = {}) ⇒ Types::ListTestSetsResponse
The list of the test sets.
-
#list_utterance_analytics_data(params = {}) ⇒ Types::ListUtteranceAnalyticsDataResponse
To use this API operation, your IAM role must have permissions to perform the [ListAggregatedUtterances][1] operation, which provides access to utterance-related analytics. -
#list_utterance_metrics(params = {}) ⇒ Types::ListUtteranceMetricsResponse
To use this API operation, your IAM role must have permissions to perform the [ListAggregatedUtterances][1] operation, which provides access to utterance-related analytics. -
#search_associated_transcripts(params = {}) ⇒ Types::SearchAssociatedTranscriptsResponse
Search for associated transcripts that meet the specified criteria.
-
#start_bot_recommendation(params = {}) ⇒ Types::StartBotRecommendationResponse
Use this to provide your transcript data, and to start the bot recommendation process.
-
#start_bot_resource_generation(params = {}) ⇒ Types::StartBotResourceGenerationResponse
Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it.
-
#start_import(params = {}) ⇒ Types::StartImportResponse
Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.
-
#start_test_execution(params = {}) ⇒ Types::StartTestExecutionResponse
The action to start test set execution.
-
#start_test_set_generation(params = {}) ⇒ Types::StartTestSetGenerationResponse
The action to start the generation of test set.
-
#stop_bot_recommendation(params = {}) ⇒ Types::StopBotRecommendationResponse
Stop an already running Bot Recommendation request.
-
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a bot, bot alias, or bot channel.
-
#update_bot(params = {}) ⇒ Types::UpdateBotResponse
Updates the configuration of an existing bot.
-
#update_bot_alias(params = {}) ⇒ Types::UpdateBotAliasResponse
Updates the configuration of an existing bot alias.
-
#update_bot_locale(params = {}) ⇒ Types::UpdateBotLocaleResponse
Updates the settings that a bot has for a specific locale.
-
#update_bot_recommendation(params = {}) ⇒ Types::UpdateBotRecommendationResponse
Updates an existing bot recommendation request.
-
#update_export(params = {}) ⇒ Types::UpdateExportResponse
Updates the password used to protect an export zip archive.
-
#update_intent(params = {}) ⇒ Types::UpdateIntentResponse
Updates the settings for an intent.
-
#update_resource_policy(params = {}) ⇒ Types::UpdateResourcePolicyResponse
Replaces the existing resource policy for a bot or bot alias with a new one.
-
#update_slot(params = {}) ⇒ Types::UpdateSlotResponse
Updates the settings for a slot.
-
#update_slot_type(params = {}) ⇒ Types::UpdateSlotTypeResponse
Updates the configuration of an existing slot type.
-
#update_test_set(params = {}) ⇒ Types::UpdateTestSetResponse
The action to update the test set.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
444 445 446 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb', line 444 def initialize(*args) super end |
Instance Method Details
#batch_create_custom_vocabulary_item(params = {}) ⇒ Types::BatchCreateCustomVocabularyItemResponse
Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.
515 516 517 518 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb', line 515 def batch_create_custom_vocabulary_item(params = {}, = {}) req = build_request(:batch_create_custom_vocabulary_item, params) req.send_request() end |
#batch_delete_custom_vocabulary_item(params = {}) ⇒ Types::BatchDeleteCustomVocabularyItemResponse
Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.
583 584 585 586 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb', line 583 def batch_delete_custom_vocabulary_item(params = {}, = {}) req = build_request(:batch_delete_custom_vocabulary_item, params) req.send_request() end |
#batch_update_custom_vocabulary_item(params = {}) ⇒ Types::BatchUpdateCustomVocabularyItemResponse
Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.
655 656 657 658 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb', line 655 def batch_update_custom_vocabulary_item(params = {}, = {}) req = build_request(:batch_update_custom_vocabulary_item, params) req.send_request() end |
#build_bot_locale(params = {}) ⇒ Types::BuildBotLocaleResponse
Builds a bot, its intents, and its slot types into a specific locale. A bot can be built into multiple locales. At runtime the locale is used to choose a specific build of the bot.
714 715 716 717 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb', line 714 def build_bot_locale(params = {}, = {}) req = build_request(:build_bot_locale, params) req.send_request() end |
#create_bot(params = {}) ⇒ Types::CreateBotResponse
Creates an Amazon Lex conversational bot.
833 834 835 836 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb', line 833 def create_bot(params = {}, = {}) req = build_request(:create_bot, params) req.send_request() end |
#create_bot_alias(params = {}) ⇒ Types::CreateBotAliasResponse
Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.
For example, you can create an alias called "PROD" that your applications use to call the Amazon Lex bot.
984 985 986 987 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb', line 984 def create_bot_alias(params = {}, = {}) req = build_request(:create_bot_alias, params) req.send_request() end |
#create_bot_locale(params = {}) ⇒ Types::CreateBotLocaleResponse
Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.
1148 1149 1150 1151 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb', line 1148 def create_bot_locale(params = {}, = {}) req = build_request(:create_bot_locale, params) req.send_request() end |
#create_bot_replica(params = {}) ⇒ Types::CreateBotReplicaResponse
Action to create a replication of the source bot in the secondary region.
1191 1192 1193 1194 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb', line 1191 def create_bot_replica(params = {}, = {}) req = build_request(:create_bot_replica, params) req.send_request() end |
#create_bot_version(params = {}) ⇒ Types::CreateBotVersionResponse
Creates an immutable version of the bot. When you create the first version of a bot, Amazon Lex sets the version number to 1. Subsequent bot versions increase in an increment of 1. The version number will always represent the total number of versions created of the bot, not the current number of versions. If a bot version is deleted, that bot version number will not be reused.
1251 1252 1253 1254 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb', line 1251 def create_bot_version(params = {}, = {}) req = build_request(:create_bot_version, params) req.send_request() end |
#create_export(params = {}) ⇒ Types::CreateExportResponse
Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot.
You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale.
For more information about exporting bots, and about the structure of the export archive, see Importing and exporting bots
1337 1338 1339 1340 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb', line 1337 def create_export(params = {}, = {}) req = build_request(:create_export, params) req.send_request() end |
#create_intent(params = {}) ⇒ Types::CreateIntentResponse
Creates an intent.
To define the interaction between the user and your bot, you define
one or more intents. For example, for a pizza ordering bot you would
create an OrderPizza
intent.
When you create an intent, you must provide a name. You can optionally provide the following:
Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents.
Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application.
How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available.
A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?"
A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza."
A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"
1511 1512 1513 1514 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb', line 1511 def create_intent(params = {}, = {}) req = build_request(:create_intent, params) req.send_request() end |
#create_resource_policy(params = {}) ⇒ Types::CreateResourcePolicyResponse
Creates a new resource policy with the specified policy statements.
1556 1557 1558 1559 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb', line 1556 def create_resource_policy(params = {}, = {}) req = build_request(:create_resource_policy, params) req.send_request() end |
#create_resource_policy_statement(params = {}) ⇒ Types::CreateResourcePolicyStatementResponse
Adds a new resource policy statement to a bot or bot alias. If a resource policy exists, the statement is added to the current resource policy. If a policy doesn't exist, a new policy is created.
You can't create a resource policy statement that allows cross-account access.
You need to add the CreateResourcePolicy
or UpdateResourcePolicy
action to the bot role in order to call the API.
1663 1664 1665 1666 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb', line 1663 def create_resource_policy_statement(params = {}, = {}) req = build_request(:create_resource_policy_statement, params) req.send_request() end |
#create_slot(params = {}) ⇒ Types::CreateSlotResponse
Creates a slot in an intent. A slot is a variable needed to fulfill an
intent. For example, an OrderPizza
intent might need slots for size,
crust, and number of pizzas. For each slot, you define one or more
utterances that Amazon Lex uses to elicit a response from the user.