ListMembersCommand

Suggest an Edit

Lists all members within a collaboration.

Example Syntax

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

import { CleanRoomsClient, ListMembersCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import
// const { CleanRoomsClient, ListMembersCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import
const client = new CleanRoomsClient(config);
const input = { // ListMembersInput
  collaborationIdentifier: "STRING_VALUE", // required
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListMembersCommand(input);
const response = await client.send(command);
// { // ListMembersOutput
//   nextToken: "STRING_VALUE",
//   memberSummaries: [ // MemberSummaryList // required
//     { // MemberSummary
//       accountId: "STRING_VALUE", // required
//       status: "STRING_VALUE", // required
//       displayName: "STRING_VALUE", // required
//       abilities: [ // MemberAbilities // required
//         "CAN_QUERY" || "CAN_RECEIVE_RESULTS" || "CAN_RUN_JOB",
//       ],
//       mlAbilities: { // MLMemberAbilities
//         customMLMemberAbilities: [ // CustomMLMemberAbilities // required
//           "CAN_RECEIVE_MODEL_OUTPUT" || "CAN_RECEIVE_INFERENCE_OUTPUT",
//         ],
//       },
//       createTime: new Date("TIMESTAMP"), // required
//       updateTime: new Date("TIMESTAMP"), // required
//       membershipId: "STRING_VALUE",
//       membershipArn: "STRING_VALUE",
//       paymentConfiguration: { // PaymentConfiguration
//         queryCompute: { // QueryComputePaymentConfig
//           isResponsible: true || false, // required
//         },
//         machineLearning: { // MLPaymentConfig
//           modelTraining: { // ModelTrainingPaymentConfig
//             isResponsible: true || false, // required
//           },
//           modelInference: { // ModelInferencePaymentConfig
//             isResponsible: true || false, // required
//           },
//         },
//         jobCompute: { // JobComputePaymentConfig
//           isResponsible: true || false, // required
//         },
//       },
//     },
//   ],
// };

ListMembersCommand Input

See ListMembersCommandInput for more details

Parameter
Type
Description
collaborationIdentifier
Required
string | undefined

The identifier of the collaboration in which the members are listed.

maxResults
number | undefined

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

nextToken
string | undefined

The pagination token that's used to fetch the next set of results.

ListMembersCommand Output

See ListMembersCommandOutput for details

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

The list of members returned by the ListMembers operation.

nextToken
string | undefined

The pagination token that's used to fetch the next set of results.

Throws

Name
Fault
Details
AccessDeniedException
client

Caller does not have sufficient access to perform this action.

InternalServerException
server

Unexpected error during processing of request.

ResourceNotFoundException
client

Request references a resource which does not exist.

ThrottlingException
client

Request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the specified constraints.

CleanRoomsServiceException
Base exception class for all service exceptions from CleanRooms service.