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.

ListMembers

Lists details about all member accounts for the current Security Hub master account.

Request Syntax

GET /members?MaxResults=MaxResults&NextToken=NextToken&OnlyAssociated=OnlyAssociated HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

MaxResults

The maximum number of items that you want in the response.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

Paginates results. Set the value of this parameter to NULL on your first call to the ListMembers operation. For subsequent calls to the operation, fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

OnlyAssociated

Specifies which member accounts the response includes based on their relationship status with the master account. The default value is TRUE. If onlyAssociated is set to TRUE, the response includes member accounts whose relationship status with the master is set to ENABLED or DISABLED. If onlyAssociated is set to FALSE, the response includes all existing member accounts.

Request Body

The request does not have a request body.

Response Syntax

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

Member details returned by the operation.

Type: Array of Member objects

NextToken

The token that is required for pagination.

Type: String

Pattern: .*\S.*

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

See Also

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