You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::GuardDuty::Types::ListMembersRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb

Overview

Note:

When making an API call, you may pass ListMembersRequest data as a hash:

{
  detector_id: "DetectorId", # required
  max_results: 1,
  next_token: "String",
  only_associated: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#detector_idString

The unique ID of the detector the member is associated with.

Returns:

  • (String)


2414
2415
2416
2417
2418
2419
2420
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 2414

class ListMembersRequest < Struct.new(
  :detector_id,
  :max_results,
  :next_token,
  :only_associated)
  include Aws::Structure
end

#max_resultsInteger

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.

Returns:

  • (Integer)


2414
2415
2416
2417
2418
2419
2420
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 2414

class ListMembersRequest < Struct.new(
  :detector_id,
  :max_results,
  :next_token,
  :only_associated)
  include Aws::Structure
end

#next_tokenString

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

Returns:

  • (String)


2414
2415
2416
2417
2418
2419
2420
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 2414

class ListMembersRequest < Struct.new(
  :detector_id,
  :max_results,
  :next_token,
  :only_associated)
  include Aws::Structure
end

#only_associatedString

Specifies whether to only return associated members or to return all members (including members which haven't been invited yet or have been disassociated).

Returns:

  • (String)


2414
2415
2416
2417
2418
2419
2420
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 2414

class ListMembersRequest < Struct.new(
  :detector_id,
  :max_results,
  :next_token,
  :only_associated)
  include Aws::Structure
end