GetMembersCommand

Suggest an Edit

Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs.

Example Syntax

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

import { GuardDutyClient, GetMembersCommand } from "@aws-sdk/client-guardduty"; // ES Modules import
// const { GuardDutyClient, GetMembersCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import
const client = new GuardDutyClient(config);
const input = { // GetMembersRequest
  DetectorId: "STRING_VALUE", // required
  AccountIds: [ // AccountIds // required
    "STRING_VALUE",
  ],
};
const command = new GetMembersCommand(input);
const response = await client.send(command);
// { // GetMembersResponse
//   Members: [ // Members // required
//     { // Member
//       AccountId: "STRING_VALUE", // required
//       DetectorId: "STRING_VALUE",
//       MasterId: "STRING_VALUE", // required
//       Email: "STRING_VALUE", // required
//       RelationshipStatus: "STRING_VALUE", // required
//       InvitedAt: "STRING_VALUE",
//       UpdatedAt: "STRING_VALUE", // required
//       AdministratorId: "STRING_VALUE",
//     },
//   ],
//   UnprocessedAccounts: [ // UnprocessedAccounts // required
//     { // UnprocessedAccount
//       AccountId: "STRING_VALUE", // required
//       Result: "STRING_VALUE", // required
//     },
//   ],
// };

GetMembersCommand Input

See GetMembersCommandInput for more details

Parameter
Type
Description
AccountIds
Required
string[] | undefined

A list of account IDs of the GuardDuty member accounts that you want to describe.

DetectorId
Required
string | undefined

The unique ID of the detector of the GuardDuty account whose members you want to retrieve.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors  API.

GetMembersCommand Output

See GetMembersCommandOutput for details

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

A list of members.

UnprocessedAccounts
Required
UnprocessedAccount[] | undefined

A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

Throws

Name
Fault
Details
BadRequestException
client

A bad request exception object.

InternalServerErrorException
server

An internal server error exception object.

GuardDutyServiceException
Base exception class for all service exceptions from GuardDuty service.