Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeManagedProductsByVendor

Provides high-level information for the managed rule groups owned by a specific vendor.

Request Syntax


{
   "Scope": "string",
   "VendorName": "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.

Scope

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 AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance.

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 | REGIONAL

Required: Yes

VendorName

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Response Syntax


{
   "ManagedProducts": [ 
      { 
         "IsAdvancedManagedRuleSet": boolean,
         "IsVersioningSupported": boolean,
         "ManagedRuleSetName": "string",
         "ProductDescription": "string",
         "ProductId": "string",
         "ProductLink": "string",
         "ProductTitle": "string",
         "SnsTopicArn": "string",
         "VendorName": "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.

ManagedProducts

High-level information for the managed rule groups owned by the specified vendor.

Type: Array of ManagedProductDescriptor objects

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 WebACL with a DefaultAction that 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