Sign In to the Console
Amazon WorkMail
API Reference (API Version 2017-10-01)

AWS Documentation » Amazon WorkMail » API Reference » Actions » ListGroupMembers

ListGroupMembers

Returns an overview of the members of a group. Users and groups can be members of a group.

Request Syntax

{
   "GroupId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "OrganizationId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

GroupId

The identifier for the group to which the members (users or groups) are associated.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 256.

Required: Yes

MaxResults

The maximum number of results to return in a single call.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The token to use to retrieve the next page of results. The first call does not contain any tokens.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

OrganizationId

The identifier for the organization under which the group exists.

Type: String

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

Response Syntax

{
   "Members": [ 
      { 
         "DisabledDate": number,
         "EnabledDate": number,
         "Id": "string",
         "Name": "string",
         "State": "string",
         "Type": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Members

The members associated to the group.

Type: Array of Member objects

NextToken

The token to use to retrieve the next page of results. The first call does not contain any tokens.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Errors

For information about the errors that are common to all actions, see Common Errors.

EntityNotFoundException

The identifier supplied for the user, group, or resource does not exist in your organization.

HTTP Status Code: 400

EntityStateException

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to update a deleted user.

HTTP Status Code: 400

InvalidParameterException

One or more of the input parameters don't match the service's restrictions.

HTTP Status Code: 400

OrganizationNotFoundException

An operation received a valid organization identifier that either doesn't belong or exist in the system.

HTTP Status Code: 400

OrganizationStateException

The organization must have a valid state (Active or Synchronizing) to perform certain operations on the organization or its members.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: