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

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

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

Overview

Note:

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

{
  authentication_token: "AuthenticationHeaderType",
  search_query: "SearchQueryType", # required
  organization_id: "IdType",
  marker: "MarkerType",
  limit: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

Returns:

  • (String)


1230
1231
1232
1233
1234
1235
1236
1237
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1230

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

#limitInteger

The maximum number of items to return with this call.

Returns:

  • (Integer)


1230
1231
1232
1233
1234
1235
1236
1237
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1230

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

#markerString

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

Returns:

  • (String)


1230
1231
1232
1233
1234
1235
1236
1237
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1230

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

#organization_idString

The ID of the organization.

Returns:

  • (String)


1230
1231
1232
1233
1234
1235
1236
1237
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1230

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

#search_queryString

A query to describe groups by group name.

Returns:

  • (String)


1230
1231
1232
1233
1234
1235
1236
1237
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1230

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