aws_sdk_wafv2/client/

get_rule_group.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetRuleGroup`](crate::operation::get_rule_group::builders::GetRuleGroupFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::get_rule_group::builders::GetRuleGroupFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::get_rule_group::builders::GetRuleGroupFluentBuilder::set_name):<br>required: **false**<br><p>The name of the rule group. You cannot change the name of a rule group after you create it.</p><br>
    ///   - [`scope(Scope)`](crate::operation::get_rule_group::builders::GetRuleGroupFluentBuilder::scope) / [`set_scope(Option<Scope>)`](crate::operation::get_rule_group::builders::GetRuleGroupFluentBuilder::set_scope):<br>required: **false**<br><p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</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_rule_group::builders::GetRuleGroupFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::get_rule_group::builders::GetRuleGroupFluentBuilder::set_id):<br>required: **false**<br><p>A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</p><br>
    ///   - [`arn(impl Into<String>)`](crate::operation::get_rule_group::builders::GetRuleGroupFluentBuilder::arn) / [`set_arn(Option<String>)`](crate::operation::get_rule_group::builders::GetRuleGroupFluentBuilder::set_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the entity.</p><br>
    /// - On success, responds with [`GetRuleGroupOutput`](crate::operation::get_rule_group::GetRuleGroupOutput) with field(s):
    ///   - [`rule_group(Option<RuleGroup>)`](crate::operation::get_rule_group::GetRuleGroupOutput::rule_group): <p></p>
    ///   - [`lock_token(Option<String>)`](crate::operation::get_rule_group::GetRuleGroupOutput::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>
    /// - On failure, responds with [`SdkError<GetRuleGroupError>`](crate::operation::get_rule_group::GetRuleGroupError)
    pub fn get_rule_group(&self) -> crate::operation::get_rule_group::builders::GetRuleGroupFluentBuilder {
        crate::operation::get_rule_group::builders::GetRuleGroupFluentBuilder::new(self.handle.clone())
    }
}