Struct aws_sdk_lexmodelsv2::operation::list_session_metrics::ListSessionMetricsInput

#[non_exhaustive]
pub struct ListSessionMetricsInput {
    pub bot_id: Option<String>,
    pub start_date_time: Option<DateTime>,
    pub end_date_time: Option<DateTime>,
    pub metrics: Option<Vec<AnalyticsSessionMetric>>,
    pub bin_by: Option<Vec<AnalyticsBinBySpecification>>,
    pub group_by: Option<Vec<AnalyticsSessionGroupBySpecification>>,
    pub filters: Option<Vec<AnalyticsSessionFilter>>,
    pub max_results: Option<i32>,
    pub next_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bot_id: Option<String>

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

start_date_time: Option<DateTime>

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

end_date_time: Option<DateTime>

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

metrics: Option<Vec<AnalyticsSessionMetric>>

A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

bin_by: Option<Vec<AnalyticsBinBySpecification>>

A list of objects, each of which contains specifications for organizing the results by time.

group_by: Option<Vec<AnalyticsSessionGroupBySpecification>>

A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide.

• LocaleId – The unique identifier of the bot locale.

filters: Option<Vec<AnalyticsSessionFilter>>

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

max_results: Option<i32>

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.

next_token: Option<String>

If the response from the ListSessionMetrics 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 ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.

Implementations

impl ListSessionMetricsInput

pub fn bot_id(&self) -> Option<&str>

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

pub fn start_date_time(&self) -> Option<&DateTime>

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

pub fn end_date_time(&self) -> Option<&DateTime>

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

pub fn metrics(&self) -> &[AnalyticsSessionMetric]

A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .metrics.is_none().

pub fn bin_by(&self) -> &[AnalyticsBinBySpecification]

A list of objects, each of which contains specifications for organizing the results by time.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .bin_by.is_none().

pub fn group_by(&self) -> &[AnalyticsSessionGroupBySpecification]

A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide.

• LocaleId – The unique identifier of the bot locale.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .group_by.is_none().

pub fn filters(&self) -> &[AnalyticsSessionFilter]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .filters.is_none().

pub fn max_results(&self) -> Option<i32>

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.

pub fn next_token(&self) -> Option<&str>

If the response from the ListSessionMetrics 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 ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.

impl ListSessionMetricsInput

pub fn builder() -> ListSessionMetricsInputBuilder

Creates a new builder-style object to manufacture ListSessionMetricsInput.

Trait Implementations

impl Clone for ListSessionMetricsInput

fn clone(&self) -> ListSessionMetricsInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListSessionMetricsInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ListSessionMetricsInput

fn eq(&self, other: &ListSessionMetricsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListSessionMetricsInput