aws_sdk_accessanalyzer/client/get_finding_v2.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 [`GetFindingV2`](crate::operation::get_finding_v2::builders::GetFindingV2FluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_finding_v2::builders::GetFindingV2FluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`analyzer_arn(impl Into<String>)`](crate::operation::get_finding_v2::builders::GetFindingV2FluentBuilder::analyzer_arn) / [`set_analyzer_arn(Option<String>)`](crate::operation::get_finding_v2::builders::GetFindingV2FluentBuilder::set_analyzer_arn):<br>required: **true**<br><p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources">ARN of the analyzer</a> that generated the finding.</p><br>
8 /// - [`id(impl Into<String>)`](crate::operation::get_finding_v2::builders::GetFindingV2FluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::get_finding_v2::builders::GetFindingV2FluentBuilder::set_id):<br>required: **true**<br><p>The ID of the finding to retrieve.</p><br>
9 /// - [`max_results(i32)`](crate::operation::get_finding_v2::builders::GetFindingV2FluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_finding_v2::builders::GetFindingV2FluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in the response.</p><br>
10 /// - [`next_token(impl Into<String>)`](crate::operation::get_finding_v2::builders::GetFindingV2FluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_finding_v2::builders::GetFindingV2FluentBuilder::set_next_token):<br>required: **false**<br><p>A token used for pagination of results returned.</p><br>
11 /// - On success, responds with [`GetFindingV2Output`](crate::operation::get_finding_v2::GetFindingV2Output) with field(s):
12 /// - [`analyzed_at(DateTime)`](crate::operation::get_finding_v2::GetFindingV2Output::analyzed_at): <p>The time at which the resource-based policy or IAM entity that generated the finding was analyzed.</p>
13 /// - [`created_at(DateTime)`](crate::operation::get_finding_v2::GetFindingV2Output::created_at): <p>The time at which the finding was created.</p>
14 /// - [`error(Option<String>)`](crate::operation::get_finding_v2::GetFindingV2Output::error): <p>An error.</p>
15 /// - [`id(String)`](crate::operation::get_finding_v2::GetFindingV2Output::id): <p>The ID of the finding to retrieve.</p>
16 /// - [`next_token(Option<String>)`](crate::operation::get_finding_v2::GetFindingV2Output::next_token): <p>A token used for pagination of results returned.</p>
17 /// - [`resource(Option<String>)`](crate::operation::get_finding_v2::GetFindingV2Output::resource): <p>The resource that generated the finding.</p>
18 /// - [`resource_type(ResourceType)`](crate::operation::get_finding_v2::GetFindingV2Output::resource_type): <p>The type of the resource identified in the finding.</p>
19 /// - [`resource_owner_account(String)`](crate::operation::get_finding_v2::GetFindingV2Output::resource_owner_account): <p>Tye Amazon Web Services account ID that owns the resource.</p>
20 /// - [`status(FindingStatus)`](crate::operation::get_finding_v2::GetFindingV2Output::status): <p>The status of the finding.</p>
21 /// - [`updated_at(DateTime)`](crate::operation::get_finding_v2::GetFindingV2Output::updated_at): <p>The time at which the finding was updated.</p>
22 /// - [`finding_details(Vec::<FindingDetails>)`](crate::operation::get_finding_v2::GetFindingV2Output::finding_details): <p>A localized message that explains the finding and provides guidance on how to address it.</p>
23 /// - [`finding_type(Option<FindingType>)`](crate::operation::get_finding_v2::GetFindingV2Output::finding_type): <p>The type of the finding. For external access analyzers, the type is <code>ExternalAccess</code>. For unused access analyzers, the type can be <code>UnusedIAMRole</code>, <code>UnusedIAMUserAccessKey</code>, <code>UnusedIAMUserPassword</code>, or <code>UnusedPermission</code>. For internal access analyzers, the type is <code>InternalAccess</code>.</p>
24 /// - On failure, responds with [`SdkError<GetFindingV2Error>`](crate::operation::get_finding_v2::GetFindingV2Error)
25 pub fn get_finding_v2(&self) -> crate::operation::get_finding_v2::builders::GetFindingV2FluentBuilder {
26 crate::operation::get_finding_v2::builders::GetFindingV2FluentBuilder::new(self.handle.clone())
27 }
28}