InviteMembers - Amazon GuardDuty

InviteMembers

Invites other AWS accounts (created as members of the current AWS account by CreateMembers) to enable GuardDuty, and allow the current AWS account to view and manage these accounts' findings on their behalf as the GuardDuty administrator account.

Request Syntax

POST /detector/detectorId/member/invite HTTP/1.1 Content-type: application/json { "accountIds": [ "string" ], "disableEmailNotification": boolean, "message": "string" }

URI Request Parameters

The request uses the following URI parameters.

detectorId

The unique ID of the detector of the GuardDuty account that you want to invite members with.

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 account IDs of the accounts that you want to invite to GuardDuty as members.

Type: Array of strings

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

Length Constraints: Fixed length of 12.

Required: Yes

disableEmailNotification

A Boolean value that specifies whether you want to disable email notification to the accounts that you are inviting to GuardDuty as members.

Type: Boolean

Required: No

message

The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.

Type: String

Required: No

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 contain the unprocessed account and a result string that explains why it 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: