aws_sdk_lexmodelsv2/client/
list_intent_paths.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ListIntentPaths`](crate::operation::list_intent_paths::builders::ListIntentPathsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`bot_id(impl Into<String>)`](crate::operation::list_intent_paths::builders::ListIntentPathsFluentBuilder::bot_id) / [`set_bot_id(Option<String>)`](crate::operation::list_intent_paths::builders::ListIntentPathsFluentBuilder::set_bot_id):<br>required: **true**<br><p>The identifier for the bot for which you want to retrieve intent path metrics.</p><br>
7    ///   - [`start_date_time(DateTime)`](crate::operation::list_intent_paths::builders::ListIntentPathsFluentBuilder::start_date_time) / [`set_start_date_time(Option<DateTime>)`](crate::operation::list_intent_paths::builders::ListIntentPathsFluentBuilder::set_start_date_time):<br>required: **true**<br><p>The date and time that marks the beginning of the range of time for which you want to see intent path metrics.</p><br>
8    ///   - [`end_date_time(DateTime)`](crate::operation::list_intent_paths::builders::ListIntentPathsFluentBuilder::end_date_time) / [`set_end_date_time(Option<DateTime>)`](crate::operation::list_intent_paths::builders::ListIntentPathsFluentBuilder::set_end_date_time):<br>required: **true**<br><p>The date and time that marks the end of the range of time for which you want to see intent path metrics.</p><br>
9    ///   - [`intent_path(impl Into<String>)`](crate::operation::list_intent_paths::builders::ListIntentPathsFluentBuilder::intent_path) / [`set_intent_path(Option<String>)`](crate::operation::list_intent_paths::builders::ListIntentPathsFluentBuilder::set_intent_path):<br>required: **true**<br><p>The intent path for which you want to retrieve metrics. Use a forward slash to separate intents in the path. For example:</p> <ul>  <li>   <p>/BookCar</p></li>  <li>   <p>/BookCar/BookHotel</p></li>  <li>   <p>/BookHotel/BookCar</p></li> </ul><br>
10    ///   - [`filters(AnalyticsPathFilter)`](crate::operation::list_intent_paths::builders::ListIntentPathsFluentBuilder::filters) / [`set_filters(Option<Vec::<AnalyticsPathFilter>>)`](crate::operation::list_intent_paths::builders::ListIntentPathsFluentBuilder::set_filters):<br>required: **false**<br><p>A list of objects, each describes a condition by which you want to filter the results.</p><br>
11    /// - On success, responds with [`ListIntentPathsOutput`](crate::operation::list_intent_paths::ListIntentPathsOutput) with field(s):
12    ///   - [`node_summaries(Option<Vec::<AnalyticsIntentNodeSummary>>)`](crate::operation::list_intent_paths::ListIntentPathsOutput::node_summaries): <p>A list of objects, each of which contains information about a node in the intent path for which you requested metrics.</p>
13    /// - On failure, responds with [`SdkError<ListIntentPathsError>`](crate::operation::list_intent_paths::ListIntentPathsError)
14    pub fn list_intent_paths(&self) -> crate::operation::list_intent_paths::builders::ListIntentPathsFluentBuilder {
15        crate::operation::list_intent_paths::builders::ListIntentPathsFluentBuilder::new(self.handle.clone())
16    }
17}