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

Inherits:

Struct

• Object
• Struct
• Aws::WorkDocs::Types::DescribeGroupsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-workdocs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:authentication_token, :search_query]

Instance Attribute Summary

• #authentication_token ⇒ String

  Amazon WorkDocs authentication token.

• #limit ⇒ Integer

  The maximum number of items to return with this call.

• #marker ⇒ String

  The marker for the next set of results.

• #organization_id ⇒ String

  The ID of the organization.

• #search_query ⇒ String

  A query to describe groups by group name.

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)

# File '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)

# File '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)

# File '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)

# File '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)

# File '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