AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeGroupsRequest as input to an Aws::Client method, you can use a vanilla 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. Not required when using AWS administrator credentials to access the API.

Returns:

  • (String)

    Amazon WorkDocs authentication token.

#limitInteger

The maximum number of items to return with this call.

Returns:

  • (Integer)

    The maximum number of items to return with this call.

#markerString

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

Returns:

  • (String)

    The marker for the next set of results.

#organization_idString

The ID of the organization.

Returns:

  • (String)

    The ID of the organization.

#search_queryString

A query to describe groups by group name.

Returns:

  • (String)

    A query to describe groups by group name.