- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListRoleMembershipsCommand
Lists all groups that are associated with a role.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QuickSightClient, ListRoleMembershipsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, ListRoleMembershipsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // ListRoleMembershipsRequest
Role: "ADMIN" || "AUTHOR" || "READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO", // required
NextToken: "STRING_VALUE",
MaxResults: Number("int"),
AwsAccountId: "STRING_VALUE", // required
Namespace: "STRING_VALUE", // required
};
const command = new ListRoleMembershipsCommand(input);
const response = await client.send(command);
// { // ListRoleMembershipsResponse
// MembersList: [ // GroupsList
// "STRING_VALUE",
// ],
// NextToken: "STRING_VALUE",
// RequestId: "STRING_VALUE",
// Status: Number("int"),
// };
ListRoleMembershipsCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
AwsAccountId Required | string | undefined | The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account. |
Namespace Required | string | undefined | The namespace that includes the role. |
Role Required | Role | undefined | The name of the role. |
MaxResults | number | undefined | The maximum number of results to return. |
NextToken | string | undefined | A pagination token that can be used in a subsequent request. |
ListRoleMembershipsCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
MembersList | string[] | undefined | The list of groups associated with a role |
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 |
---|
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 |
InvalidParameterValueException | client | One or more parameters has a value that isn't valid. |
LimitExceededException | client | A limit is exceeded. |
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. |