aws_sdk_xray/client/
get_insight_events.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetInsightEvents`](crate::operation::get_insight_events::builders::GetInsightEventsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_insight_events::builders::GetInsightEventsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`insight_id(impl Into<String>)`](crate::operation::get_insight_events::builders::GetInsightEventsFluentBuilder::insight_id) / [`set_insight_id(Option<String>)`](crate::operation::get_insight_events::builders::GetInsightEventsFluentBuilder::set_insight_id):<br>required: **true**<br><p>The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.</p><br>
    ///   - [`max_results(i32)`](crate::operation::get_insight_events::builders::GetInsightEventsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_insight_events::builders::GetInsightEventsFluentBuilder::set_max_results):<br>required: **false**<br><p>Used to retrieve at most the specified value of events.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::get_insight_events::builders::GetInsightEventsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_insight_events::builders::GetInsightEventsFluentBuilder::set_next_token):<br>required: **false**<br><p>Specify the pagination token returned by a previous request to retrieve the next page of events.</p><br>
    /// - On success, responds with [`GetInsightEventsOutput`](crate::operation::get_insight_events::GetInsightEventsOutput) with field(s):
    ///   - [`insight_events(Option<Vec::<InsightEvent>>)`](crate::operation::get_insight_events::GetInsightEventsOutput::insight_events): <p>A detailed description of the event. This includes the time of the event, client and root cause impact statistics, and the top anomalous service at the time of the event.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::get_insight_events::GetInsightEventsOutput::next_token): <p>Use this token to retrieve the next page of insight events.</p>
    /// - On failure, responds with [`SdkError<GetInsightEventsError>`](crate::operation::get_insight_events::GetInsightEventsError)
    pub fn get_insight_events(&self) -> crate::operation::get_insight_events::builders::GetInsightEventsFluentBuilder {
        crate::operation::get_insight_events::builders::GetInsightEventsFluentBuilder::new(self.handle.clone())
    }
}