Class: Aws::WorkDocs::Types::DescribeGroupsRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:authentication_token, :search_query]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_token ⇒ String

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Returns:

  • (String) 


1126
1127
1128
1129
1130
1131
1132
1133
1134
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1126

class DescribeGroupsRequest < Struct.new(
  :authentication_token,
  :search_query,
  :organization_id,
  :marker,
  :limit)
  SENSITIVE = [:authentication_token, :search_query]
  include Aws::Structure
end

#limit ⇒ Integer

The maximum number of items to return with this call.

Returns:

  • (Integer) 


1126
1127
1128
1129
1130
1131
1132
1133
1134
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1126

class DescribeGroupsRequest < Struct.new(
  :authentication_token,
  :search_query,
  :organization_id,
  :marker,
  :limit)
  SENSITIVE = [:authentication_token, :search_query]
  include Aws::Structure
end

#marker ⇒ String

The marker for the next set of results. (You received this marker from a previous call.)

Returns:

  • (String) 


1126
1127
1128
1129
1130
1131
1132
1133
1134
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1126

class DescribeGroupsRequest < Struct.new(
  :authentication_token,
  :search_query,
  :organization_id,
  :marker,
  :limit)
  SENSITIVE = [:authentication_token, :search_query]
  include Aws::Structure
end

#organization_id ⇒ String

The ID of the organization.

Returns:

  • (String) 


1126
1127
1128
1129
1130
1131
1132
1133
1134
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1126

class DescribeGroupsRequest < Struct.new(
  :authentication_token,
  :search_query,
  :organization_id,
  :marker,
  :limit)
  SENSITIVE = [:authentication_token, :search_query]
  include Aws::Structure
end

#search_query ⇒ String

A query to describe groups by group name.

Returns:

  • (String) 


1126
1127
1128
1129
1130
1131
1132
1133
1134
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1126

class DescribeGroupsRequest < Struct.new(
  :authentication_token,
  :search_query,
  :organization_id,
  :marker,
  :limit)
  SENSITIVE = [:authentication_token, :search_query]
  include Aws::Structure
end