DescribeGroupsCommand

Suggest an Edit

Describes the groups specified by the query. Groups are defined by the underlying Active Directory.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkDocsClient, DescribeGroupsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
// const { WorkDocsClient, DescribeGroupsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
const client = new WorkDocsClient(config);
const input = { // DescribeGroupsRequest
  AuthenticationToken: "STRING_VALUE",
  SearchQuery: "STRING_VALUE", // required
  OrganizationId: "STRING_VALUE",
  Marker: "STRING_VALUE",
  Limit: Number("int"),
};
const command = new DescribeGroupsCommand(input);
const response = await client.send(command);
// { // DescribeGroupsResponse
//   Groups: [ // GroupMetadataList
//     { // GroupMetadata
//       Id: "STRING_VALUE",
//       Name: "STRING_VALUE",
//     },
//   ],
//   Marker: "STRING_VALUE",
// };

DescribeGroupsCommand Input

See DescribeGroupsCommandInput for more details

Parameter
Type
Description
SearchQuery
Required
string | undefined

A query to describe groups by group name.

AuthenticationToken
string | undefined

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

Limit
number | undefined

The maximum number of items to return with this call.

Marker
string | undefined

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

OrganizationId
string | undefined

The ID of the organization.

DescribeGroupsCommand Output

See DescribeGroupsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Groups
GroupMetadata[] | undefined

The list of groups.

Marker
string | undefined

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Throws

Name
Fault
Details
FailedDependencyException
client

The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.

ServiceUnavailableException
server

One or more of the dependencies is unavailable.

UnauthorizedOperationException
client

The operation is not permitted.

UnauthorizedResourceAccessException
client

The caller does not have access to perform the action on the resource.

WorkDocsServiceException
Base exception class for all service exceptions from WorkDocs service.