Class: Aws::Shield::Types::ListProtectionGroupsRequest

Inherits:

Struct

• Object
• Struct
• Aws::Shield::Types::ListProtectionGroupsRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-shield/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #inclusion_filters ⇒ Types::InclusionProtectionGroupFilters

  Narrows the set of protection groups that the call retrieves.

• #max_results ⇒ Integer

  The greatest number of objects that you want Shield Advanced to return to the list request.

• #next_token ⇒ 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.

Instance Attribute Details

#inclusion_filters ⇒ Types::InclusionProtectionGroupFilters

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.

Returns:

• (Types::InclusionProtectionGroupFilters)

# File 'lib/aws-sdk-shield/types.rb', line 1328

class ListProtectionGroupsRequest < Struct.new(
  :next_token,
  :max_results,
  :inclusion_filters)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ 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.

Returns:

• (Integer)

# File 'lib/aws-sdk-shield/types.rb', line 1328

class ListProtectionGroupsRequest < Struct.new(
  :next_token,
  :max_results,
  :inclusion_filters)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ 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 than `MaxResults` 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.

Returns:

• (String)

# File 'lib/aws-sdk-shield/types.rb', line 1328

class ListProtectionGroupsRequest < Struct.new(
  :next_token,
  :max_results,
  :inclusion_filters)
  SENSITIVE = []
  include Aws::Structure
end