aws_sdk_accessanalyzer/operation/validate_policy/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::validate_policy::_validate_policy_output::ValidatePolicyOutputBuilder;
3
4pub use crate::operation::validate_policy::_validate_policy_input::ValidatePolicyInputBuilder;
5
6impl crate::operation::validate_policy::builders::ValidatePolicyInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::validate_policy::ValidatePolicyOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::validate_policy::ValidatePolicyError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.validate_policy();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `ValidatePolicy`.
24///
25/// <p>Requests the validation of a policy and returns a list of findings. The findings help you identify issues and provide actionable recommendations to resolve the issue and enable you to author functional policies that meet security best practices.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct ValidatePolicyFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::validate_policy::builders::ValidatePolicyInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::validate_policy::ValidatePolicyOutput,
35 crate::operation::validate_policy::ValidatePolicyError,
36 > for ValidatePolicyFluentBuilder
37{
38 fn send(
39 self,
40 config_override: crate::config::Builder,
41 ) -> crate::client::customize::internal::BoxFuture<
42 crate::client::customize::internal::SendResult<
43 crate::operation::validate_policy::ValidatePolicyOutput,
44 crate::operation::validate_policy::ValidatePolicyError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl ValidatePolicyFluentBuilder {
51 /// Creates a new `ValidatePolicyFluentBuilder`.
52 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53 Self {
54 handle,
55 inner: ::std::default::Default::default(),
56 config_override: ::std::option::Option::None,
57 }
58 }
59 /// Access the ValidatePolicy as a reference.
60 pub fn as_input(&self) -> &crate::operation::validate_policy::builders::ValidatePolicyInputBuilder {
61 &self.inner
62 }
63 /// Sends the request and returns the response.
64 ///
65 /// If an error occurs, an `SdkError` will be returned with additional details that
66 /// can be matched against.
67 ///
68 /// By default, any retryable failures will be retried twice. Retry behavior
69 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70 /// set when configuring the client.
71 pub async fn send(
72 self,
73 ) -> ::std::result::Result<
74 crate::operation::validate_policy::ValidatePolicyOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::validate_policy::ValidatePolicyError,
77 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78 >,
79 > {
80 let input = self
81 .inner
82 .build()
83 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84 let runtime_plugins = crate::operation::validate_policy::ValidatePolicy::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::validate_policy::ValidatePolicy::orchestrate(&runtime_plugins, input).await
90 }
91
92 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93 pub fn customize(
94 self,
95 ) -> crate::client::customize::CustomizableOperation<
96 crate::operation::validate_policy::ValidatePolicyOutput,
97 crate::operation::validate_policy::ValidatePolicyError,
98 Self,
99 > {
100 crate::client::customize::CustomizableOperation::new(self)
101 }
102 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103 self.set_config_override(::std::option::Option::Some(config_override.into()));
104 self
105 }
106
107 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108 self.config_override = config_override;
109 self
110 }
111 /// Create a paginator for this request
112 ///
113 /// Paginators are used by calling [`send().await`](crate::operation::validate_policy::paginator::ValidatePolicyPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114 pub fn into_paginator(self) -> crate::operation::validate_policy::paginator::ValidatePolicyPaginator {
115 crate::operation::validate_policy::paginator::ValidatePolicyPaginator::new(self.handle, self.inner)
116 }
117 /// <p>The locale to use for localizing the findings.</p>
118 pub fn locale(mut self, input: crate::types::Locale) -> Self {
119 self.inner = self.inner.locale(input);
120 self
121 }
122 /// <p>The locale to use for localizing the findings.</p>
123 pub fn set_locale(mut self, input: ::std::option::Option<crate::types::Locale>) -> Self {
124 self.inner = self.inner.set_locale(input);
125 self
126 }
127 /// <p>The locale to use for localizing the findings.</p>
128 pub fn get_locale(&self) -> &::std::option::Option<crate::types::Locale> {
129 self.inner.get_locale()
130 }
131 /// <p>The maximum number of results to return in the response.</p>
132 pub fn max_results(mut self, input: i32) -> Self {
133 self.inner = self.inner.max_results(input);
134 self
135 }
136 /// <p>The maximum number of results to return in the response.</p>
137 pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
138 self.inner = self.inner.set_max_results(input);
139 self
140 }
141 /// <p>The maximum number of results to return in the response.</p>
142 pub fn get_max_results(&self) -> &::std::option::Option<i32> {
143 self.inner.get_max_results()
144 }
145 /// <p>A token used for pagination of results returned.</p>
146 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
147 self.inner = self.inner.next_token(input.into());
148 self
149 }
150 /// <p>A token used for pagination of results returned.</p>
151 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
152 self.inner = self.inner.set_next_token(input);
153 self
154 }
155 /// <p>A token used for pagination of results returned.</p>
156 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
157 self.inner.get_next_token()
158 }
159 /// <p>The JSON policy document to use as the content for the policy.</p>
160 pub fn policy_document(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
161 self.inner = self.inner.policy_document(input.into());
162 self
163 }
164 /// <p>The JSON policy document to use as the content for the policy.</p>
165 pub fn set_policy_document(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
166 self.inner = self.inner.set_policy_document(input);
167 self
168 }
169 /// <p>The JSON policy document to use as the content for the policy.</p>
170 pub fn get_policy_document(&self) -> &::std::option::Option<::std::string::String> {
171 self.inner.get_policy_document()
172 }
173 /// <p>The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.</p>
174 /// <p>Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.</p>
175 /// <p>Service control policies (SCPs) are a type of organization policy attached to an Amazon Web Services organization, organizational unit (OU), or an account.</p>
176 pub fn policy_type(mut self, input: crate::types::PolicyType) -> Self {
177 self.inner = self.inner.policy_type(input);
178 self
179 }
180 /// <p>The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.</p>
181 /// <p>Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.</p>
182 /// <p>Service control policies (SCPs) are a type of organization policy attached to an Amazon Web Services organization, organizational unit (OU), or an account.</p>
183 pub fn set_policy_type(mut self, input: ::std::option::Option<crate::types::PolicyType>) -> Self {
184 self.inner = self.inner.set_policy_type(input);
185 self
186 }
187 /// <p>The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.</p>
188 /// <p>Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.</p>
189 /// <p>Service control policies (SCPs) are a type of organization policy attached to an Amazon Web Services organization, organizational unit (OU), or an account.</p>
190 pub fn get_policy_type(&self) -> &::std::option::Option<crate::types::PolicyType> {
191 self.inner.get_policy_type()
192 }
193 /// <p>The type of resource to attach to your resource policy. Specify a value for the policy validation resource type only if the policy type is <code>RESOURCE_POLICY</code>. For example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose <code>AWS::S3::Bucket</code> for the policy validation resource type.</p>
194 /// <p>For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource policies.</p>
195 pub fn validate_policy_resource_type(mut self, input: crate::types::ValidatePolicyResourceType) -> Self {
196 self.inner = self.inner.validate_policy_resource_type(input);
197 self
198 }
199 /// <p>The type of resource to attach to your resource policy. Specify a value for the policy validation resource type only if the policy type is <code>RESOURCE_POLICY</code>. For example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose <code>AWS::S3::Bucket</code> for the policy validation resource type.</p>
200 /// <p>For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource policies.</p>
201 pub fn set_validate_policy_resource_type(mut self, input: ::std::option::Option<crate::types::ValidatePolicyResourceType>) -> Self {
202 self.inner = self.inner.set_validate_policy_resource_type(input);
203 self
204 }
205 /// <p>The type of resource to attach to your resource policy. Specify a value for the policy validation resource type only if the policy type is <code>RESOURCE_POLICY</code>. For example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose <code>AWS::S3::Bucket</code> for the policy validation resource type.</p>
206 /// <p>For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource policies.</p>
207 pub fn get_validate_policy_resource_type(&self) -> &::std::option::Option<crate::types::ValidatePolicyResourceType> {
208 self.inner.get_validate_policy_resource_type()
209 }
210}