aws_sdk_securityhub/client/get_insights.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 [`GetInsights`](crate::operation::get_insights::builders::GetInsightsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_insights::builders::GetInsightsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`insight_arns(impl Into<String>)`](crate::operation::get_insights::builders::GetInsightsFluentBuilder::insight_arns) / [`set_insight_arns(Option<Vec::<String>>)`](crate::operation::get_insights::builders::GetInsightsFluentBuilder::set_insight_arns):<br>required: **false**<br><p>The ARNs of the insights to describe. If you don't provide any insight ARNs, then <code>GetInsights</code> returns all of your custom insights. It does not return any managed insights.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::get_insights::builders::GetInsightsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_insights::builders::GetInsightsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token that is required for pagination. On your first call to the <code>GetInsights</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p><br>
9 /// - [`max_results(i32)`](crate::operation::get_insights::builders::GetInsightsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_insights::builders::GetInsightsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to return in the response.</p><br>
10 /// - On success, responds with [`GetInsightsOutput`](crate::operation::get_insights::GetInsightsOutput) with field(s):
11 /// - [`insights(Option<Vec::<Insight>>)`](crate::operation::get_insights::GetInsightsOutput::insights): <p>The insights returned by the operation.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::get_insights::GetInsightsOutput::next_token): <p>The pagination token to use to request the next page of results.</p>
13 /// - On failure, responds with [`SdkError<GetInsightsError>`](crate::operation::get_insights::GetInsightsError)
14 pub fn get_insights(&self) -> crate::operation::get_insights::builders::GetInsightsFluentBuilder {
15 crate::operation::get_insights::builders::GetInsightsFluentBuilder::new(self.handle.clone())
16 }
17}