aws_sdk_detective/client/list_investigations.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 [`ListInvestigations`](crate::operation::list_investigations::builders::ListInvestigationsFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`graph_arn(impl Into<String>)`](crate::operation::list_investigations::builders::ListInvestigationsFluentBuilder::graph_arn) / [`set_graph_arn(Option<String>)`](crate::operation::list_investigations::builders::ListInvestigationsFluentBuilder::set_graph_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the behavior graph.</p><br>
7 /// - [`next_token(impl Into<String>)`](crate::operation::list_investigations::builders::ListInvestigationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_investigations::builders::ListInvestigationsFluentBuilder::set_next_token):<br>required: **false**<br><p>Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.</p> <p>Each pagination token expires after 24 hours. Using an expired pagination token will return a Validation Exception error.</p><br>
8 /// - [`max_results(i32)`](crate::operation::list_investigations::builders::ListInvestigationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_investigations::builders::ListInvestigationsFluentBuilder::set_max_results):<br>required: **false**<br><p>Lists the maximum number of investigations in a page.</p><br>
9 /// - [`filter_criteria(FilterCriteria)`](crate::operation::list_investigations::builders::ListInvestigationsFluentBuilder::filter_criteria) / [`set_filter_criteria(Option<FilterCriteria>)`](crate::operation::list_investigations::builders::ListInvestigationsFluentBuilder::set_filter_criteria):<br>required: **false**<br><p>Filters the investigation results based on a criteria.</p><br>
10 /// - [`sort_criteria(SortCriteria)`](crate::operation::list_investigations::builders::ListInvestigationsFluentBuilder::sort_criteria) / [`set_sort_criteria(Option<SortCriteria>)`](crate::operation::list_investigations::builders::ListInvestigationsFluentBuilder::set_sort_criteria):<br>required: **false**<br><p>Sorts the investigation results based on a criteria.</p><br>
11 /// - On success, responds with [`ListInvestigationsOutput`](crate::operation::list_investigations::ListInvestigationsOutput) with field(s):
12 /// - [`investigation_details(Option<Vec::<InvestigationDetail>>)`](crate::operation::list_investigations::ListInvestigationsOutput::investigation_details): <p>Lists the summary of uncommon behavior or malicious activity which indicates a compromise.</p>
13 /// - [`next_token(Option<String>)`](crate::operation::list_investigations::ListInvestigationsOutput::next_token): <p>Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.</p> <p>Each pagination token expires after 24 hours.</p>
14 /// - On failure, responds with [`SdkError<ListInvestigationsError>`](crate::operation::list_investigations::ListInvestigationsError)
15 pub fn list_investigations(&self) -> crate::operation::list_investigations::builders::ListInvestigationsFluentBuilder {
16 crate::operation::list_investigations::builders::ListInvestigationsFluentBuilder::new(self.handle.clone())
17 }
18}