Interface ListAggregatedUtterancesRequest.Builder

    • Method Detail

      • botId

        ListAggregatedUtterancesRequest.Builder botId​(String botId)

        The unique identifier of the bot associated with this request.

        Parameters:
        botId - The unique identifier of the bot associated with this request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • botAliasId

        ListAggregatedUtterancesRequest.Builder botAliasId​(String botAliasId)

        The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.

        Parameters:
        botAliasId - The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • botVersion

        ListAggregatedUtterancesRequest.Builder botVersion​(String botVersion)

        The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.

        Parameters:
        botVersion - The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • localeId

        ListAggregatedUtterancesRequest.Builder localeId​(String localeId)

        The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.

        Parameters:
        localeId - The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • aggregationDuration

        ListAggregatedUtterancesRequest.Builder aggregationDuration​(UtteranceAggregationDuration aggregationDuration)

        The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.

        Parameters:
        aggregationDuration - The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • sortBy

        ListAggregatedUtterancesRequest.Builder sortBy​(AggregatedUtterancesSortBy sortBy)

        Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.

        Parameters:
        sortBy - Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • filters

        ListAggregatedUtterancesRequest.Builder filters​(Collection<AggregatedUtterancesFilter> filters)

        Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

        Parameters:
        filters - Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • filters

        ListAggregatedUtterancesRequest.Builder filters​(AggregatedUtterancesFilter... filters)

        Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

        Parameters:
        filters - Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • maxResults

        ListAggregatedUtterancesRequest.Builder maxResults​(Integer maxResults)

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

        Parameters:
        maxResults - The maximum number of utterances to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned. If you don't specify the maxResults parameter, 1,000 results are returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • nextToken

        ListAggregatedUtterancesRequest.Builder nextToken​(String nextToken)

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

        Parameters:
        nextToken - If the response from the ListAggregatedUtterances operation contains more results that specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.