Struct aws_sdk_lexmodelsv2::operation::list_session_analytics_data::builders::ListSessionAnalyticsDataFluentBuilder

pub struct ListSessionAnalyticsDataFluentBuilder { /* private fields */ }

Fluent builder constructing a request to ListSessionAnalyticsData.

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.

Implementations

impl ListSessionAnalyticsDataFluentBuilder

pub fn as_input(&self) -> &ListSessionAnalyticsDataInputBuilder

Access the ListSessionAnalyticsData as a reference.

pub async fn send( self ) -> Result<ListSessionAnalyticsDataOutput, SdkError<ListSessionAnalyticsDataError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub async fn customize( self ) -> Result<CustomizableOperation<ListSessionAnalyticsDataOutput, ListSessionAnalyticsDataError, Self>, SdkError<ListSessionAnalyticsDataError>>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn into_paginator(self) -> ListSessionAnalyticsDataPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn bot_id(self, input: impl Into<String>) -> Self

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

pub fn set_bot_id(self, input: Option<String>) -> Self

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

pub fn get_bot_id(&self) -> &Option<String>

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

pub fn start_date_time(self, input: DateTime) -> Self

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

pub fn set_start_date_time(self, input: Option<DateTime>) -> Self

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

pub fn get_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 analytics.

pub fn end_date_time(self, input: DateTime) -> Self

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

pub fn set_end_date_time(self, input: Option<DateTime>) -> Self

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

pub fn get_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 analytics.

pub fn sort_by(self, input: SessionDataSortBy) -> Self

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

pub fn set_sort_by(self, input: Option<SessionDataSortBy>) -> Self

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

pub fn get_sort_by(&self) -> &Option<SessionDataSortBy>

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

pub fn filters(self, input: AnalyticsSessionFilter) -> Self

Appends an item to filters.

To override the contents of this collection use set_filters.

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

pub fn set_filters(self, input: Option<Vec<AnalyticsSessionFilter>>) -> Self

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

pub fn get_filters(&self) -> &Option<Vec<AnalyticsSessionFilter>>

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

pub fn max_results(self, input: i32) -> Self

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 set_max_results(self, input: Option<i32>) -> Self

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 get_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, input: impl Into<String>) -> Self

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.

pub fn set_next_token(self, input: Option<String>) -> Self

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.

pub fn get_next_token(&self) -> &Option<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.

Trait Implementations

impl Clone for ListSessionAnalyticsDataFluentBuilder

fn clone(&self) -> ListSessionAnalyticsDataFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListSessionAnalyticsDataFluentBuilder

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

Formats the value using the given formatter.