aws_sdk_accessanalyzer/client/
check_no_public_access.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 [`CheckNoPublicAccess`](crate::operation::check_no_public_access::builders::CheckNoPublicAccessFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`policy_document(impl Into<String>)`](crate::operation::check_no_public_access::builders::CheckNoPublicAccessFluentBuilder::policy_document) / [`set_policy_document(Option<String>)`](crate::operation::check_no_public_access::builders::CheckNoPublicAccessFluentBuilder::set_policy_document):<br>required: **true**<br><p>The JSON policy document to evaluate for public access.</p><br>
7    ///   - [`resource_type(AccessCheckResourceType)`](crate::operation::check_no_public_access::builders::CheckNoPublicAccessFluentBuilder::resource_type) / [`set_resource_type(Option<AccessCheckResourceType>)`](crate::operation::check_no_public_access::builders::CheckNoPublicAccessFluentBuilder::set_resource_type):<br>required: **true**<br><p>The type of resource to evaluate for public access. For example, to check for public access to Amazon S3 buckets, you can choose <code>AWS::S3::Bucket</code> for the resource type.</p> <p>For resource types not supported as valid values, IAM Access Analyzer will return an error.</p><br>
8    /// - On success, responds with [`CheckNoPublicAccessOutput`](crate::operation::check_no_public_access::CheckNoPublicAccessOutput) with field(s):
9    ///   - [`result(Option<CheckNoPublicAccessResult>)`](crate::operation::check_no_public_access::CheckNoPublicAccessOutput::result): <p>The result of the check for public access to the specified resource type. If the result is <code>PASS</code>, the policy doesn't allow public access to the specified resource type. If the result is <code>FAIL</code>, the policy might allow public access to the specified resource type.</p>
10    ///   - [`message(Option<String>)`](crate::operation::check_no_public_access::CheckNoPublicAccessOutput::message): <p>The message indicating whether the specified policy allows public access to resources.</p>
11    ///   - [`reasons(Option<Vec::<ReasonSummary>>)`](crate::operation::check_no_public_access::CheckNoPublicAccessOutput::reasons): <p>A list of reasons why the specified resource policy grants public access for the resource type.</p>
12    /// - On failure, responds with [`SdkError<CheckNoPublicAccessError>`](crate::operation::check_no_public_access::CheckNoPublicAccessError)
13    pub fn check_no_public_access(&self) -> crate::operation::check_no_public_access::builders::CheckNoPublicAccessFluentBuilder {
14        crate::operation::check_no_public_access::builders::CheckNoPublicAccessFluentBuilder::new(self.handle.clone())
15    }
16}