Class: Aws::LexModelsV2::Types::ListSessionAnalyticsDataRequest

Inherits:

Struct

• Object
• Struct
• Aws::LexModelsV2::Types::ListSessionAnalyticsDataRequest

Includes:

Structure

Defined in:

lib/aws-sdk-lexmodelsv2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bot_id ⇒ String

  The identifier for the bot for which you want to retrieve session analytics.

• #end_date_time ⇒ Time

  The date and time that marks the end of the range of time for which you want to see session analytics.

• #filters ⇒ Array<Types::AnalyticsSessionFilter>

  A list of objects, each of which describes a condition by which you want to filter the results.

• #max_results ⇒ Integer

  The maximum number of results to return in each page of results.

• #next_token ⇒ String

  If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.

• #sort_by ⇒ Types::SessionDataSortBy

  An object specifying the measure and method by which to sort the session analytics data.

• #start_date_time ⇒ Time

  The date and time that marks the beginning of the range of time for which you want to see session analytics.

Instance Attribute Details

#bot_id ⇒ String

The identifier for the bot for which you want to retrieve session analytics.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 10831

class ListSessionAnalyticsDataRequest < Struct.new(
  :bot_id,
  :start_date_time,
  :end_date_time,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#end_date_time ⇒ Time

The date and time that marks the end of the range of time for which you want to see session analytics.

Returns:

• (Time)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 10831

class ListSessionAnalyticsDataRequest < Struct.new(
  :bot_id,
  :start_date_time,
  :end_date_time,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::AnalyticsSessionFilter>

A list of objects, each of which describes a condition by which you want to filter the results.

Returns:

• (Array<Types::AnalyticsSessionFilter>)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 10831

class ListSessionAnalyticsDataRequest < Struct.new(
  :bot_id,
  :start_date_time,
  :end_date_time,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results 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.

Returns:

• (Integer)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 10831

class ListSessionAnalyticsDataRequest < Struct.new(
  :bot_id,
  :start_date_time,
  :end_date_time,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 10831

class ListSessionAnalyticsDataRequest < Struct.new(
  :bot_id,
  :start_date_time,
  :end_date_time,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#sort_by ⇒ Types::SessionDataSortBy

An object specifying the measure and method by which to sort the session analytics data.

Returns:

• (Types::SessionDataSortBy)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 10831

class ListSessionAnalyticsDataRequest < Struct.new(
  :bot_id,
  :start_date_time,
  :end_date_time,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#start_date_time ⇒ Time

The date and time that marks the beginning of the range of time for which you want to see session analytics.

Returns:

• (Time)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 10831

class ListSessionAnalyticsDataRequest < Struct.new(
  :bot_id,
  :start_date_time,
  :end_date_time,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end