AWS Security Hub
AWS Security Hub (API Version 2018-10-26)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

GetMembers

Returns the details on the Security Hub member accounts that the account IDs specify.

Request Syntax

POST /members/get HTTP/1.1 Content-type: application/json { "AccountIds": [ "string" ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AccountIds

A list of account IDs for the Security Hub member accounts that you want to return the details for.

Type: Array of strings

Pattern: .*\S.*

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Members": [ { "AccountId": "string", "Email": "string", "InvitedAt": number, "MasterId": "string", "MemberStatus": "string", "UpdatedAt": number } ], "UnprocessedAccounts": [ { "AccountId": "string", "ProcessingResult": "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

A list of details about the Security Hub member accounts.

Type: Array of Member objects

UnprocessedAccounts

A list of account ID and email address pairs of the AWS accounts that couldn't be processed.

Type: Array of Result objects

Errors

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

InternalException

Internal server error.

HTTP Status Code: 500

InvalidAccessException

AWS Security Hub isn't enabled for the account used to make this request.

HTTP Status Code: 401

InvalidInputException

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

HTTP Status Code: 400

LimitExceededException

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

HTTP Status Code: 429

ResourceNotFoundException

The request was rejected because we can't find the specified resource.

HTTP Status Code: 404

See Also

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