Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with a specific pattern, aggregation, or resource type. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.
Contents
- Aggregations
-
The aggregation setting of the protection groups that you want to retrieve.
Type: Array of strings
Array Members: Fixed number of 1 item.
Valid Values:
SUM | MEAN | MAX
Required: No
- Patterns
-
The pattern specification of the protection groups that you want to retrieve.
Type: Array of strings
Array Members: Fixed number of 1 item.
Valid Values:
ALL | ARBITRARY | BY_RESOURCE_TYPE
Required: No
- ProtectionGroupIds
-
The ID of the protection group that you want to retrieve.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern:
[a-zA-Z0-9\\-]*
Required: No
- ResourceTypes
-
The resource type configuration of the protection groups that you want to retrieve. In the protection group configuration, you specify the resource type when you set the group's
Pattern
toBY_RESOURCE_TYPE
.Type: Array of strings
Array Members: Fixed number of 1 item.
Valid Values:
CLOUDFRONT_DISTRIBUTION | ROUTE_53_HOSTED_ZONE | ELASTIC_IP_ALLOCATION | CLASSIC_LOAD_BALANCER | APPLICATION_LOAD_BALANCER | GLOBAL_ACCELERATOR
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: