ListResourcesInProtectionGroup
Retrieves the resources that are included in the protection group.
Request Syntax
{
"MaxResults": number,
"NextToken": "string",
"ProtectionGroupId": "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.
- 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
- ProtectionGroupId
-
The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern:
[a-zA-Z0-9\\-]*Required: Yes
Response Syntax
{
"NextToken": "string",
"ResourceArns": [ "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:
^.*$ - ResourceArns
-
The Amazon Resource Names (ARNs) of the resources that are included in the protection group.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws.*
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:
