aws_sdk_wafv2/client/
get_web_acl.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetWebACL`](crate::operation::get_web_acl::builders::GetWebACLFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::get_web_acl::builders::GetWebACLFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::get_web_acl::builders::GetWebACLFluentBuilder::set_name):<br>required: **true**<br><p>The name of the web ACL. You cannot change the name of a web ACL after you create it.</p><br>
    ///   - [`scope(Scope)`](crate::operation::get_web_acl::builders::GetWebACLFluentBuilder::scope) / [`set_scope(Option<Scope>)`](crate::operation::get_web_acl::builders::GetWebACLFluentBuilder::set_scope):<br>required: **true**<br><p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.</p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p> <ul>  <li>   <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>  <li>   <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li> </ul><br>
    ///   - [`id(impl Into<String>)`](crate::operation::get_web_acl::builders::GetWebACLFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::get_web_acl::builders::GetWebACLFluentBuilder::set_id):<br>required: **true**<br><p>The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</p><br>
    /// - On success, responds with [`GetWebAclOutput`](crate::operation::get_web_acl::GetWebAclOutput) with field(s):
    ///   - [`web_acl(Option<WebAcl>)`](crate::operation::get_web_acl::GetWebAclOutput::web_acl): <p>The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or create a new one.</p>
    ///   - [`lock_token(Option<String>)`](crate::operation::get_web_acl::GetWebAclOutput::lock_token): <p>A token used for optimistic locking. WAF returns a token to your <code>get</code> and <code>list</code> requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like <code>update</code> and <code>delete</code>. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another <code>get</code>, and use the new token returned by that operation.</p>
    ///   - [`application_integration_url(Option<String>)`](crate::operation::get_web_acl::GetWebAclOutput::application_integration_url): <p>The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group <code>AWSManagedRulesATPRuleSet</code> and the account creation fraud prevention managed rule group <code>AWSManagedRulesACFPRuleSet</code>. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html">WAF client application integration</a> in the <i>WAF Developer Guide</i>.</p>
    /// - On failure, responds with [`SdkError<GetWebACLError>`](crate::operation::get_web_acl::GetWebACLError)
    pub fn get_web_acl(&self) -> crate::operation::get_web_acl::builders::GetWebACLFluentBuilder {
        crate::operation::get_web_acl::builders::GetWebACLFluentBuilder::new(self.handle.clone())
    }
}
aws_sdk_wafv2/client/get_web_acl.rs

aws_sdk_wafv2/client/
get_web_acl.rs
