aws_sdk_accessanalyzer/client/
get_finding_recommendation.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetFindingRecommendation`](crate::operation::get_finding_recommendation::builders::GetFindingRecommendationFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_finding_recommendation::builders::GetFindingRecommendationFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`analyzer_arn(impl Into<String>)`](crate::operation::get_finding_recommendation::builders::GetFindingRecommendationFluentBuilder::analyzer_arn) / [`set_analyzer_arn(Option<String>)`](crate::operation::get_finding_recommendation::builders::GetFindingRecommendationFluentBuilder::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> used to generate the finding recommendation.</p><br>
    ///   - [`id(impl Into<String>)`](crate::operation::get_finding_recommendation::builders::GetFindingRecommendationFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::get_finding_recommendation::builders::GetFindingRecommendationFluentBuilder::set_id):<br>required: **true**<br><p>The unique ID for the finding recommendation.</p><br>
    ///   - [`max_results(i32)`](crate::operation::get_finding_recommendation::builders::GetFindingRecommendationFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_finding_recommendation::builders::GetFindingRecommendationFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in the response.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::get_finding_recommendation::builders::GetFindingRecommendationFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_finding_recommendation::builders::GetFindingRecommendationFluentBuilder::set_next_token):<br>required: **false**<br><p>A token used for pagination of results returned.</p><br>
    /// - On success, responds with [`GetFindingRecommendationOutput`](crate::operation::get_finding_recommendation::GetFindingRecommendationOutput) with field(s):
    ///   - [`started_at(DateTime)`](crate::operation::get_finding_recommendation::GetFindingRecommendationOutput::started_at): <p>The time at which the retrieval of the finding recommendation was started.</p>
    ///   - [`completed_at(Option<DateTime>)`](crate::operation::get_finding_recommendation::GetFindingRecommendationOutput::completed_at): <p>The time at which the retrieval of the finding recommendation was completed.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::get_finding_recommendation::GetFindingRecommendationOutput::next_token): <p>A token used for pagination of results returned.</p>
    ///   - [`error(Option<RecommendationError>)`](crate::operation::get_finding_recommendation::GetFindingRecommendationOutput::error): <p>Detailed information about the reason that the retrieval of a recommendation for the finding failed.</p>
    ///   - [`resource_arn(String)`](crate::operation::get_finding_recommendation::GetFindingRecommendationOutput::resource_arn): <p>The ARN of the resource of the finding.</p>
    ///   - [`recommended_steps(Option<Vec::<RecommendedStep>>)`](crate::operation::get_finding_recommendation::GetFindingRecommendationOutput::recommended_steps): <p>A group of recommended steps for the finding.</p>
    ///   - [`recommendation_type(RecommendationType)`](crate::operation::get_finding_recommendation::GetFindingRecommendationOutput::recommendation_type): <p>The type of recommendation for the finding.</p>
    ///   - [`status(Status)`](crate::operation::get_finding_recommendation::GetFindingRecommendationOutput::status): <p>The status of the retrieval of the finding recommendation.</p>
    /// - On failure, responds with [`SdkError<GetFindingRecommendationError>`](crate::operation::get_finding_recommendation::GetFindingRecommendationError)
    pub fn get_finding_recommendation(&self) -> crate::operation::get_finding_recommendation::builders::GetFindingRecommendationFluentBuilder {
        crate::operation::get_finding_recommendation::builders::GetFindingRecommendationFluentBuilder::new(self.handle.clone())
    }
}