ListProtectionGroups
Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.
Request Syntax
{
"InclusionFilters": {
"Aggregations": [ "string" ],
"Patterns": [ "string" ],
"ProtectionGroupIds": [ "string" ],
"ResourceTypes": [ "string" ]
},
"MaxResults": number,
"NextToken": "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.
- InclusionFilters
-
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 specific pattern or aggregation settings. 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.
Type: InclusionProtectionGroupFilters object
Required: No
- MaxResults
-
The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a
NextTokenvalue in the response.The default setting is 20.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 10000.
Required: No
- NextToken
-
When you request a list of objects from AWS Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a
NextTokenvalue in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the
MaxResultssetting. Shield Advanced will not return more thanMaxResultsobjects, but may return fewer, even if more objects are still available.Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a
NextTokenvalue.On your first call to a list operation, leave this setting empty.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Pattern:
^.*$Required: No
Response Syntax
{
"NextToken": "string",
"ProtectionGroups": [
{
"Aggregation": "string",
"Members": [ "string" ],
"Pattern": "string",
"ProtectionGroupArn": "string",
"ProtectionGroupId": "string",
"ResourceType": "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.
- NextToken
-
When you request a list of objects from AWS Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a
NextTokenvalue in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the
MaxResultssetting. Shield Advanced will not return more thanMaxResultsobjects, but may return fewer, even if more objects are still available.Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a
NextTokenvalue.Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Pattern:
^.*$ - ProtectionGroups
-
Type: Array of ProtectionGroup objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
HTTP Status Code: 500
- InvalidPaginationTokenException
-
Exception that indicates that the
NextTokenspecified in the request is invalid. Submit the request using theNextTokenvalue that was returned in the prior response.HTTP Status Code: 400
- ResourceNotFoundException
-
Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
