getRuleGroup method

Future<GetRuleGroupResponse> getRuleGroup({ required String id, required String name, required Scope scope, })

Retrieves the specified RuleGroup.

May throw WAFInternalErrorException. May throw WAFInvalidParameterException. May throw WAFNonexistentItemException. May throw WAFInvalidOperationException.

Parameter id : 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.

Parameter name : The name of the rule group. You cannot change the name of a rule group after you create it.

Parameter scope : Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
• API and SDKs - For all calls, use the Region endpoint us-east-1.

Implementation

Future<GetRuleGroupResponse> getRuleGroup({
  required String id,
  required String name,
  required Scope scope,
}) async {
  ArgumentError.checkNotNull(id, 'id');
  _s.validateStringLength(
    'id',
    id,
    1,
    36,
    isRequired: true,
  );
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'name',
    name,
    1,
    128,
    isRequired: true,
  );
  ArgumentError.checkNotNull(scope, 'scope');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSWAF_20190729.GetRuleGroup'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Id': id,
      'Name': name,
      'Scope': scope.toValue(),
    },
  );

  return GetRuleGroupResponse.fromJson(jsonResponse.body);
}