ListGroupMembershipsCommand

Lists member users in a group.

Example Syntax

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

import { QuickSightClient, ListGroupMembershipsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, ListGroupMembershipsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // ListGroupMembershipsRequest
  GroupName: "STRING_VALUE", // required
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  AwsAccountId: "STRING_VALUE", // required
  Namespace: "STRING_VALUE", // required
};
const command = new ListGroupMembershipsCommand(input);
const response = await client.send(command);
// { // ListGroupMembershipsResponse
//   GroupMemberList: [ // GroupMemberList
//     { // GroupMember
//       Arn: "STRING_VALUE",
//       MemberName: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
//   RequestId: "STRING_VALUE",
//   Status: Number("int"),
// };

ListGroupMembershipsCommand Input

Parameter
Type
Description
AwsAccountId
Required
string | undefined

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

GroupName
Required
string | undefined

The name of the group that you want to see a membership list of.

Namespace
Required
string | undefined

The namespace of the group that you want a list of users from.

MaxResults
number | undefined

The maximum number of results to return from this request.

NextToken
string | undefined

A pagination token that can be used in a subsequent request.

ListGroupMembershipsCommand Output

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

The list of the members of the group.

NextToken
string | undefined

A pagination token that can be used in a subsequent request.

RequestId
string | undefined

The Amazon Web Services request ID for this operation.

Status
number | undefined

The HTTP status of the request.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

InternalFailureException
server

An internal failure occurred.

InvalidNextTokenException
client

The NextToken value isn't valid.

InvalidParameterValueException
client

One or more parameters has a value that isn't valid.

PreconditionNotMetException
client

One or more preconditions aren't met.

ResourceNotFoundException
client

One or more resources can't be found.

ResourceUnavailableException
server

This resource is currently unavailable.

ThrottlingException
client

Access is throttled.

QuickSightServiceException
Base exception class for all service exceptions from QuickSight service.