CreateMembers - Amazon GuardDuty

CreateMembers

Creates member accounts of the current AWS account by specifying a list of AWS account IDs. The current AWS account can then invite these members to manage GuardDuty in their accounts.

Request Syntax

POST /detector/detectorId/member HTTP/1.1 Content-type: application/json { "accountDetails": [ { "accountId": "string", "email": "string" } ] }

URI Request Parameters

The request requires the following URI parameters.

detectorId

The unique ID of the detector of the GuardDuty account that you want to associate member accounts with.

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

Request Body

The request accepts the following data in JSON format.

accountDetails

A list of account ID and email address pairs of the accounts that you want to associate with the master GuardDuty account.

Type: Array of AccountDetail objects

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

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "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.

unprocessedAccounts

A list of objects that include the accountIds of the unprocessed accounts and a result string that explains why each was unprocessed.

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: