ListProjectMembershipsCommand

Suggest an Edit

Lists all members of the specified project.

Example Syntax

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

import { DataZoneClient, ListProjectMembershipsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListProjectMembershipsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListProjectMembershipsInput
  domainIdentifier: "STRING_VALUE", // required
  projectIdentifier: "STRING_VALUE", // required
  sortBy: "NAME",
  sortOrder: "ASCENDING" || "DESCENDING",
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListProjectMembershipsCommand(input);
const response = await client.send(command);
// { // ListProjectMembershipsOutput
//   members: [ // ProjectMembers // required
//     { // ProjectMember
//       memberDetails: { // MemberDetails Union: only one key present
//         user: { // UserDetails
//           userId: "STRING_VALUE", // required
//         },
//         group: { // GroupDetails
//           groupId: "STRING_VALUE", // required
//         },
//       },
//       designation: "PROJECT_OWNER" || "PROJECT_CONTRIBUTOR" || "PROJECT_CATALOG_VIEWER" || "PROJECT_CATALOG_CONSUMER" || "PROJECT_CATALOG_STEWARD", // required
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListProjectMembershipsCommand Input

See ListProjectMembershipsCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The identifier of the Amazon DataZone domain in which you want to list project memberships.

projectIdentifier
Required
string | undefined

The identifier of the project whose memberships you want to list.

maxResults
number | undefined

The maximum number of memberships to return in a single call to ListProjectMemberships. When the number of memberships to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListProjectMemberships to list the next set of memberships.

nextToken
string | undefined

When the number of memberships is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of memberships, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectMemberships to list the next set of memberships.

sortBy
SortFieldProject | undefined

The method by which you want to sort the project memberships.

sortOrder
SortOrder | undefined

The sort order of the project memberships.

ListProjectMembershipsCommand Output

See ListProjectMembershipsCommandOutput for details

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

The members of the project.

nextToken
string | undefined

When the number of memberships is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of memberships, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectMemberships to list the next set of memberships.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The specified resource cannot be found.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException
client

You do not have permission to perform this action.

DataZoneServiceException
Base exception class for all service exceptions from DataZone service.