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,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_token ⇒ String

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

Returns:

  • (String) —

    Amazon WorkDocs authentication token.

#limit ⇒ Integer

The maximum number of items to return with this call.

Returns:

  • (Integer) —

    The maximum number of items to return with this call.

#marker ⇒ String

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_id ⇒ String

The ID of the organization.

Returns:

  • (String) —

    The ID of the organization.

#search_query ⇒ String

A query to describe groups by group name.

Returns:

  • (String) —

    A query to describe groups by group name.