ListManagedRuleSets
Retrieves the managed rule sets that you own.
Note
This is intended for use only by vendors of managed rule sets. Vendors are AWS and AWS Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
Request Syntax
{
"Limit": number,
"NextMarker": "string",
"Scope": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Limit
-
The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a
NextMarkervalue that you can use in a subsequent call to get the next batch of objects.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextMarker
-
When you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
.*\S.*Required: No
- Scope
-
Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use
CLOUDFRONT.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.
Type: String
Valid Values:
CLOUDFRONT | REGIONALRequired: Yes
-
Response Syntax
{
"ManagedRuleSets": [
{
"ARN": "string",
"Description": "string",
"Id": "string",
"LabelNamespace": "string",
"LockToken": "string",
"Name": "string"
}
],
"NextMarker": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ManagedRuleSets
-
Your managed rule sets. If you specified a
Limitin your request, this might not be the full list.Type: Array of ManagedRuleSetSummary objects
- NextMarker
-
When you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
.*\S.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- WAFInternalErrorException
-
Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request.
HTTP Status Code: 500
- WAFInvalidOperationException
-
The operation isn't valid.
HTTP Status Code: 400
- WAFInvalidParameterException
-
The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
-
You specified a parameter name or value that isn't valid.
-
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
-
You tried to update a
WebACLwith aDefaultActionthat isn't among the types available at DefaultAction. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
HTTP Status Code: 400
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
