GetMemberDetectors - Amazon GuardDuty

GetMemberDetectors

Describes which data sources are enabled for the member account's detector.

There might be regional differences because some data sources might not be available in all the AWS Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

Request Syntax

POST /detector/detectorId/member/detector/get HTTP/1.1 Content-type: application/json { "accountIds": [ "string" ] }

URI Request Parameters

The request uses the following URI parameters.

detectorId

The detector ID for the administrator account.

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

Length Constraints: Minimum length of 1. Maximum length of 300.

Required: Yes

Request Body

The request accepts the following data in JSON format.

accountIds

A list of member account IDs.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Length Constraints: Fixed length of 12.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "members": [ { "accountId": "string", "dataSources": { "cloudTrail": { "status": "string" }, "dnsLogs": { "status": "string" }, "flowLogs": { "status": "string" }, "kubernetes": { "auditLogs": { "status": "string" } }, "malwareProtection": { "scanEc2InstanceWithFindings": { "ebsVolumes": { "reason": "string", "status": "string" } }, "serviceRole": "string" }, "s3Logs": { "status": "string" } }, "features": [ { "additionalConfiguration": [ { "name": "string", "status": "string", "updatedAt": number } ], "name": "string", "status": "string", "updatedAt": number } ] } ], "unprocessedAccounts": [ { "accountId": "string", "result": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

members

An object that describes which data sources are enabled for a member account.

Type: Array of MemberDataSourceConfiguration objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

unprocessedAccounts

A list of member account IDs that were unable to be processed along with an explanation for why they were not processed.

Type: Array of UnprocessedAccount objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

A bad request exception object.

HTTP Status Code: 400

InternalServerErrorException

An internal server error exception object.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: