JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
  • Detail:
  • Field |
  • Constr |
  • Method
com.amazonaws.services.lexmodelsv2

Class AmazonLexModelsV2Client

    • Method Detail

      • buildBotLocale

        public BuildBotLocaleResult buildBotLocale(BuildBotLocaleRequest request)

        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.

        Specified by:
        buildBotLocale in interface AmazonLexModelsV2
        Parameters:
        buildBotLocaleRequest -
        Returns:
        Result of the BuildBotLocale operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • createBot

        public CreateBotResult createBot(CreateBotRequest request)

        Creates an Amazon Lex conversational bot.

        Specified by:
        createBot in interface AmazonLexModelsV2
        Parameters:
        createBotRequest -
        Returns:
        Result of the CreateBot operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • createBotAlias

        public CreateBotAliasResult createBotAlias(CreateBotAliasRequest request)

        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.

        Specified by:
        createBotAlias in interface AmazonLexModelsV2
        Parameters:
        createBotAliasRequest -
        Returns:
        Result of the CreateBotAlias operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • createBotLocale

        public CreateBotLocaleResult createBotLocale(CreateBotLocaleRequest request)

        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.

        Specified by:
        createBotLocale in interface AmazonLexModelsV2
        Parameters:
        createBotLocaleRequest -
        Returns:
        Result of the CreateBotLocale operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • createBotVersion

        public CreateBotVersionResult createBotVersion(CreateBotVersionRequest request)

        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.

        Specified by:
        createBotVersion in interface AmazonLexModelsV2
        Parameters:
        createBotVersionRequest -
        Returns:
        Result of the CreateBotVersion operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • createExport

        public CreateExportResult createExport(CreateExportRequest request)

        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

        Specified by:
        createExport in interface AmazonLexModelsV2
        Parameters:
        createExportRequest -
        Returns:
        Result of the CreateExport operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        ResourceNotFoundException - You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • createIntent

        public CreateIntentResult createIntent(CreateIntentRequest request)

        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?"

        Specified by:
        createIntent in interface AmazonLexModelsV2
        Parameters:
        createIntentRequest -
        Returns:
        Result of the CreateIntent operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • createResourcePolicyStatement

        public CreateResourcePolicyStatementResult createResourcePolicyStatement(CreateResourcePolicyStatementRequest request)

        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.

        Specified by:
        createResourcePolicyStatement in interface AmazonLexModelsV2
        Parameters:
        createResourcePolicyStatementRequest -
        Returns:
        Result of the CreateResourcePolicyStatement operation returned by the service.
        Throws:
        ResourceNotFoundException - You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        See Also:
        AWS API Documentation
      • createSlot

        public CreateSlotResult createSlot(CreateSlotRequest request)

        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.

        Specified by:
        createSlot in interface AmazonLexModelsV2
        Parameters:
        createSlotRequest -
        Returns:
        Result of the CreateSlot operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • createSlotType

        public CreateSlotTypeResult createSlotType(CreateSlotTypeRequest request)

        Creates a custom slot type

        To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.

        Specified by:
        createSlotType in interface AmazonLexModelsV2
        Parameters:
        createSlotTypeRequest -
        Returns:
        Result of the CreateSlotType operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • createUploadUrl

        public CreateUploadUrlResult createUploadUrl(CreateUploadUrlRequest request)

        Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.

        Specified by:
        createUploadUrl in interface AmazonLexModelsV2
        Parameters:
        createUploadUrlRequest -
        Returns:
        Result of the CreateUploadUrl operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        ResourceNotFoundException - You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • deleteBot

        public DeleteBotResult deleteBot(DeleteBotRequest request)

        Deletes all versions of a bot, including the Draft version. To delete a specific version, use the DeleteBotVersion operation.

        When you delete a bot, all of the resources contained in the bot are also deleted. Deleting a bot removes all locales, intents, slot, and slot types defined for the bot.

        If a bot has an alias, the DeleteBot operation returns a ResourceInUseException exception. If you want to delete the bot and the alias, set the skipResourceInUseCheck parameter to true.

        Specified by:
        deleteBot in interface AmazonLexModelsV2
        Parameters:
        deleteBotRequest -
        Returns:
        Result of the DeleteBot operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • deleteBotLocale

        public DeleteBotLocaleResult deleteBotLocale(DeleteBotLocaleRequest request)

        Removes a locale from a bot.

        When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.

        Specified by:
        deleteBotLocale in interface AmazonLexModelsV2
        Parameters:
        deleteBotLocaleRequest -
        Returns:
        Result of the DeleteBotLocale operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • deleteIntent

        public DeleteIntentResult deleteIntent(DeleteIntentRequest request)

        Removes the specified intent.

        Deleting an intent also deletes the slots associated with the intent.

        Specified by:
        deleteIntent in interface AmazonLexModelsV2
        Parameters:
        deleteIntentRequest -
        Returns:
        Result of the DeleteIntent operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • deleteResourcePolicyStatement

        public DeleteResourcePolicyStatementResult deleteResourcePolicyStatement(DeleteResourcePolicyStatementRequest request)

        Deletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that doesn't exist in the policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an exception.

        You need to add the DeleteResourcePolicy or UpdateResourcePolicy action to the bot role in order to call the API.

        Specified by:
        deleteResourcePolicyStatement in interface AmazonLexModelsV2
        Parameters:
        deleteResourcePolicyStatementRequest -
        Returns:
        Result of the DeleteResourcePolicyStatement operation returned by the service.
        Throws:
        ResourceNotFoundException - You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        See Also:
        AWS API Documentation
      • deleteSlotType

        public DeleteSlotTypeResult deleteSlotType(DeleteSlotTypeRequest request)

        Deletes a slot type from a bot locale.

        If a slot is using the slot type, Amazon Lex throws a ResourceInUseException exception. To avoid the exception, set the skipResourceInUseCheck parameter to true.

        Specified by:
        deleteSlotType in interface AmazonLexModelsV2
        Parameters:
        deleteSlotTypeRequest -
        Returns:
        Result of the DeleteSlotType operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • deleteUtterances

        public DeleteUtterancesResult deleteUtterances(DeleteUtterancesRequest request)

        Deletes stored utterances.

        Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the ListAggregatedUtterances operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input..

        Use the DeleteUtterances operation to manually delete utterances for a specific session. When you use the DeleteUtterances operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the ListAggregatedUtterances operation are deleted after 15 days.

        Specified by:
        deleteUtterances in interface AmazonLexModelsV2
        Parameters:
        deleteUtterancesRequest -
        Returns:
        Result of the DeleteUtterances operation returned by the service.
        Throws:
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • describeBotRecommendation

        public DescribeBotRecommendationResult describeBotRecommendation(DescribeBotRecommendationRequest request)

        Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.

        Specified by:
        describeBotRecommendation in interface AmazonLexModelsV2
        Parameters:
        describeBotRecommendationRequest -
        Returns:
        Result of the DescribeBotRecommendation operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        ResourceNotFoundException - You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • describeBotResourceGeneration

        public DescribeBotResourceGenerationResult describeBotResourceGeneration(DescribeBotResourceGenerationRequest request)

        Returns information about a request to generate a bot through natural language description, made through the StartBotResource API. Use the generatedBotLocaleUrl to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.

        Specified by:
        describeBotResourceGeneration in interface AmazonLexModelsV2
        Parameters:
        describeBotResourceGenerationRequest -
        Returns:
        Result of the DescribeBotResourceGeneration operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        ResourceNotFoundException - You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • generateBotElement

        public GenerateBotElementResult generateBotElement(GenerateBotElementRequest request)

        Generates sample utterances for an intent.

        Specified by:
        generateBotElement in interface AmazonLexModelsV2
        Parameters:
        generateBotElementRequest -
        Returns:
        Result of the GenerateBotElement operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        ResourceNotFoundException - You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • listAggregatedUtterances

        public ListAggregatedUtterancesResult listAggregatedUtterances(ListAggregatedUtterancesRequest request)

        Provides a list of utterances that users have sent to the bot.

        Utterances are aggregated by the text of the utterance. For example, all instances where customers used the phrase "I want to order pizza" are aggregated into the same line in the response.

        You can see both detected utterances and missed utterances. A detected utterance is where the bot properly recognized the utterance and activated the associated intent. A missed utterance was not recognized by the bot and didn't activate an intent.

        Utterances can be aggregated for a bot alias or for a bot version, but not both at the same time.

        Utterances statistics are not generated under the following conditions:

        • The childDirected field was set to true when the bot was created.

        • You are using slot obfuscation with one or more slots.

        • You opted out of participating in improving Amazon Lex.

        Specified by:
        listAggregatedUtterances in interface AmazonLexModelsV2
        Parameters:
        listAggregatedUtterancesRequest -
        Returns:
        Result of the ListAggregatedUtterances operation returned by the service.
        Throws:
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • listBotVersions

        public ListBotVersionsResult listBotVersions(ListBotVersionsRequest request)

        Gets information about all of the versions of a bot.

        The ListBotVersions operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the ListBotVersions operation returns for summaries, one for each numbered version and one for the DRAFT version.

        The ListBotVersions operation always returns at least one version, the DRAFT version.

        Specified by:
        listBotVersions in interface AmazonLexModelsV2
        Parameters:
        listBotVersionsRequest -
        Returns:
        Result of the ListBotVersions operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • listIntentMetrics

        public ListIntentMetricsResult listIntentMetrics(ListIntentMetricsRequest request)

        Retrieves summary metrics for the intents in your bot. The following fields are required:

        • metrics – A list of AnalyticsIntentMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.

        • startDateTime and endDateTime – Define a time range for which you want to retrieve results.

        Of the optional fields, you can organize the results in the following ways:

        • Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results.

        • Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

        Note that an order field exists in both binBy and metrics. You can specify only one order in a given request.

        Specified by:
        listIntentMetrics in interface AmazonLexModelsV2
        Parameters:
        listIntentMetricsRequest -
        Returns:
        Result of the ListIntentMetrics operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • listIntentPaths

        public ListIntentPathsResult listIntentPaths(ListIntentPathsRequest request)

        Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required:

        • startDateTime and endDateTime – Define a time range for which you want to retrieve results.

        • intentPath – Define an order of intents for which you want to retrieve metrics. Separate intents in the path with a forward slash. For example, populate the intentPath field with /BookCar/BookHotel to see details about how many times users invoked the BookCar and BookHotel intents in that order.

        Use the optional filters field to filter the results.

        Specified by:
        listIntentPaths in interface AmazonLexModelsV2
        Parameters:
        listIntentPathsRequest -
        Returns:
        Result of the ListIntentPaths operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • listIntentStageMetrics

        public ListIntentStageMetricsResult listIntentStageMetrics(ListIntentStageMetricsRequest request)

        Retrieves summary metrics for the stages within intents in your bot. The following fields are required:

        • metrics – A list of AnalyticsIntentStageMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.

        • startDateTime and endDateTime – Define a time range for which you want to retrieve results.

        Of the optional fields, you can organize the results in the following ways:

        • Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results.

        • Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

        Note that an order field exists in both binBy and metrics. You can only specify one order in a given request.

        Specified by:
        listIntentStageMetrics in interface AmazonLexModelsV2
        Parameters:
        listIntentStageMetricsRequest -
        Returns:
        Result of the ListIntentStageMetrics operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • listSessionAnalyticsData

        public ListSessionAnalyticsDataResult listSessionAnalyticsData(ListSessionAnalyticsDataRequest request)

        Retrieves a list of metadata for individual user sessions with your bot. The startDateTime and endDateTime fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways:

        • Use the filters field to filter the results and the sortBy field to specify the values by which to sort the results.

        • Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

        Specified by:
        listSessionAnalyticsData in interface AmazonLexModelsV2
        Parameters:
        listSessionAnalyticsDataRequest -
        Returns:
        Result of the ListSessionAnalyticsData operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • listSessionMetrics

        public ListSessionMetricsResult listSessionMetrics(ListSessionMetricsRequest request)

        Retrieves summary metrics for the user sessions with your bot. The following fields are required:

        • metrics – A list of AnalyticsSessionMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.

        • startDateTime and endDateTime – Define a time range for which you want to retrieve results.

        Of the optional fields, you can organize the results in the following ways:

        • Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results.

        • Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

        Note that an order field exists in both binBy and metrics. Currently, you can specify it in either field, but not in both.

        Specified by:
        listSessionMetrics in interface AmazonLexModelsV2
        Parameters:
        listSessionMetricsRequest -
        Returns:
        Result of the ListSessionMetrics operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • listUtteranceAnalyticsData

        public ListUtteranceAnalyticsDataResult listUtteranceAnalyticsData(ListUtteranceAnalyticsDataRequest request)

        To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role.

        Retrieves a list of metadata for individual user utterances to your bot. The following fields are required:

        • startDateTime and endDateTime – Define a time range for which you want to retrieve results.

        Of the optional fields, you can organize the results in the following ways:

        • Use the filters field to filter the results and the sortBy field to specify the values by which to sort the results.

        • Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

        Specified by:
        listUtteranceAnalyticsData in interface AmazonLexModelsV2
        Parameters:
        listUtteranceAnalyticsDataRequest -
        Returns:
        Result of the ListUtteranceAnalyticsData operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • listUtteranceMetrics

        public ListUtteranceMetricsResult listUtteranceMetrics(ListUtteranceMetricsRequest request)

        To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role.

        Retrieves summary metrics for the utterances in your bot. The following fields are required:

        • metrics – A list of AnalyticsUtteranceMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.

        • startDateTime and endDateTime – Define a time range for which you want to retrieve results.

        Of the optional fields, you can organize the results in the following ways:

        • Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results.

        • Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

        Note that an order field exists in both binBy and metrics. Currently, you can specify it in either field, but not in both.

        Specified by:
        listUtteranceMetrics in interface AmazonLexModelsV2
        Parameters:
        listUtteranceMetricsRequest -
        Returns:
        Result of the ListUtteranceMetrics operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • startBotRecommendation

        public StartBotRecommendationResult startBotRecommendation(StartBotRecommendationRequest request)

        Use this to provide your transcript data, and to start the bot recommendation process.

        Specified by:
        startBotRecommendation in interface AmazonLexModelsV2
        Parameters:
        startBotRecommendationRequest -
        Returns:
        Result of the StartBotRecommendation operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        ResourceNotFoundException - You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • startBotResourceGeneration

        public StartBotResourceGenerationResult startBotResourceGeneration(StartBotResourceGenerationRequest request)

        Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it. After you make this call, use the DescribeBotResourceGeneration operation to check on the status of the generation and for the generatedBotLocaleUrl when the generation is complete. Use that value to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.

        Specified by:
        startBotResourceGeneration in interface AmazonLexModelsV2
        Parameters:
        startBotResourceGenerationRequest -
        Returns:
        Result of the StartBotResourceGeneration operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • startImport

        public StartImportResult startImport(StartImportRequest request)

        Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.

        Specified by:
        startImport in interface AmazonLexModelsV2
        Parameters:
        startImportRequest -
        Returns:
        Result of the StartImport operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        ResourceNotFoundException - You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • stopBotRecommendation

        public StopBotRecommendationResult stopBotRecommendation(StopBotRecommendationRequest request)

        Stop an already running Bot Recommendation request.

        Specified by:
        stopBotRecommendation in interface AmazonLexModelsV2
        Parameters:
        stopBotRecommendationRequest -
        Returns:
        Result of the StopBotRecommendation operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        ResourceNotFoundException - You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • tagResource

        public TagResourceResult tagResource(TagResourceRequest request)

        Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.

        Specified by:
        tagResource in interface AmazonLexModelsV2
        Parameters:
        tagResourceRequest -
        Returns:
        Result of the TagResource operation returned by the service.
        Throws:
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ResourceNotFoundException - You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        See Also:
        AWS API Documentation
      • updateBot

        public UpdateBotResult updateBot(UpdateBotRequest request)

        Updates the configuration of an existing bot.

        Specified by:
        updateBot in interface AmazonLexModelsV2
        Parameters:
        updateBotRequest -
        Returns:
        Result of the UpdateBot operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • updateBotRecommendation

        public UpdateBotRecommendationResult updateBotRecommendation(UpdateBotRecommendationRequest request)

        Updates an existing bot recommendation request.

        Specified by:
        updateBotRecommendation in interface AmazonLexModelsV2
        Parameters:
        updateBotRecommendationRequest -
        Returns:
        Result of the UpdateBotRecommendation operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        ResourceNotFoundException - You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        PreconditionFailedException - Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • updateExport

        public UpdateExportResult updateExport(UpdateExportRequest request)

        Updates the password used to protect an export zip archive.

        The password is not required. If you don't supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is available at the pre-signed S3 URL provided by the DescribeExport operation.

        Specified by:
        updateExport in interface AmazonLexModelsV2
        Parameters:
        updateExportRequest -
        Returns:
        Result of the UpdateExport operation returned by the service.
        Throws:
        ThrottlingException - Your request rate is too high. Reduce the frequency of requests.
        ServiceQuotaExceededException - You have reached a quota for your bot.
        ValidationException - One of the input parameters in your request isn't valid. Check the parameters and try your request again.
        ResourceNotFoundException - You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
        ConflictException - The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
        InternalServerException - The service encountered an unexpected condition. Try your request again.
        See Also:
        AWS API Documentation
      • getCachedResponseMetadata

        public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

        Specified by:
        getCachedResponseMetadata in interface AmazonLexModelsV2
        Parameters:
        request - The originally executed request
        Returns:
        The response metadata for the specified request, or null if none is available.
      • shutdown

        public void shutdown()
        Description copied from class: AmazonWebServiceClient
        Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
        Specified by:
        shutdown in interface AmazonLexModelsV2
        Overrides:
        shutdown in class AmazonWebServiceClient
Skip navigation links
  • Detail:
  • Field |
  • Constr |
  • Method

AltStyle によって変換されたページ (->オリジナル) /