Shield / Client / list_resources_in_protection_group
list_resources_in_protection_group#
- Shield.Client.list_resources_in_protection_group(**kwargs)#
Retrieves the resources that are included in the protection group.
See also: AWS API Documentation
Request Syntax
response = client.list_resources_in_protection_group( ProtectionGroupId='string', NextToken='string', MaxResults=123 )
- Parameters:
ProtectionGroupId (string) –
[REQUIRED]
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.
NextToken (string) –
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a
NextToken
value 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
MaxResults
setting. Shield Advanced will not return more thanMaxResults
objects, 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
NextToken
value.On your first call to a list operation, leave this setting empty.
MaxResults (integer) –
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
NextToken
value in the response.The default setting is 20.
- Return type:
dict
- Returns:
Response Syntax
{ 'ResourceArns': [ 'string', ], 'NextToken': 'string' }
Response Structure
(dict) –
ResourceArns (list) –
The Amazon Resource Names (ARNs) of the resources that are included in the protection group.
(string) –
NextToken (string) –
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a
NextToken
value 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
MaxResults
setting. Shield Advanced will not return more thanMaxResults
objects, 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
NextToken
value.
Exceptions
Shield.Client.exceptions.InternalErrorException
Shield.Client.exceptions.ResourceNotFoundException
Shield.Client.exceptions.InvalidPaginationTokenException