aws_sdk_securityhub/client/
get_recommended_policy_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 [`GetRecommendedPolicyV2`](crate::operation::get_recommended_policy_v2::builders::GetRecommendedPolicyV2FluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_recommended_policy_v2::builders::GetRecommendedPolicyV2FluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`metadata_uid(impl Into<String>)`](crate::operation::get_recommended_policy_v2::builders::GetRecommendedPolicyV2FluentBuilder::metadata_uid) / [`set_metadata_uid(Option<String>)`](crate::operation::get_recommended_policy_v2::builders::GetRecommendedPolicyV2FluentBuilder::set_metadata_uid):<br>required: **true**<br><p>The unique identifier (ID) of Security Hub OCSF findings found under the <code>metadata.uid</code> field of the finding.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::get_recommended_policy_v2::builders::GetRecommendedPolicyV2FluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_recommended_policy_v2::builders::GetRecommendedPolicyV2FluentBuilder::set_next_token):<br>required: **false**<br><p>The token used to paginate the <code>RecommendationSteps</code> list returned. On your first call to <code>GetRecommendedPolicyV2</code>, omit this parameter or set it to <code>NULL</code>. For subsequent calls, use the <code>NextToken</code> value returned in the previous response to retrieve the next page of results.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::get_recommended_policy_v2::builders::GetRecommendedPolicyV2FluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_recommended_policy_v2::builders::GetRecommendedPolicyV2FluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of recommendation steps to return.</p><br>
10    /// - On success, responds with [`GetRecommendedPolicyV2Output`](crate::operation::get_recommended_policy_v2::GetRecommendedPolicyV2Output) with field(s):
11    ///   - [`next_token(Option<String>)`](crate::operation::get_recommended_policy_v2::GetRecommendedPolicyV2Output::next_token): <p>The pagination token to use to request the next page of results.</p>
12    ///   - [`recommendation_type(Option<RecommendationType>)`](crate::operation::get_recommended_policy_v2::GetRecommendedPolicyV2Output::recommendation_type): <p>The type of recommendation for the finding.</p>
13    ///   - [`recommendation_steps(Option<Vec::<RecommendationStep>>)`](crate::operation::get_recommended_policy_v2::GetRecommendedPolicyV2Output::recommendation_steps): <p>The recommended steps to take to resolve the finding.</p>
14    ///   - [`error(Option<RecommendationError>)`](crate::operation::get_recommended_policy_v2::GetRecommendedPolicyV2Output::error): <p>Detailed information for a <code>FAILED</code> retrieval status.</p>
15    ///   - [`status(Option<RecommendationStatus>)`](crate::operation::get_recommended_policy_v2::GetRecommendedPolicyV2Output::status): <p>The current status of the recommended policy retrieval.</p>
16    ///   - [`resource_arn(Option<String>)`](crate::operation::get_recommended_policy_v2::GetRecommendedPolicyV2Output::resource_arn): <p>The ARN of the resource of the finding.</p>
17    /// - On failure, responds with [`SdkError<GetRecommendedPolicyV2Error>`](crate::operation::get_recommended_policy_v2::GetRecommendedPolicyV2Error)
18    pub fn get_recommended_policy_v2(&self) -> crate::operation::get_recommended_policy_v2::builders::GetRecommendedPolicyV2FluentBuilder {
19        crate::operation::get_recommended_policy_v2::builders::GetRecommendedPolicyV2FluentBuilder::new(self.handle.clone())
20    }
21}
aws_sdk_securityhub/client/get_recommended_policy_v2.rs

aws_sdk_securityhub/client/
get_recommended_policy_v2.rs
