Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListMembers

List members associated with the Amazon Inspector delegated administrator for your organization.

Request Syntax


POST /members/list HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string",
   "onlyAssociated": boolean
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

maxResults

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

Type: Integer

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

Required: No

nextToken

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000000.

Required: No

onlyAssociated

Specifies whether to list only currently associated members if True or to list all members within the organization if False.

Type: Boolean

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "members": [ 
      { 
         "accountId": "string",
         "delegatedAdminAccountId": "string",
         "relationshipStatus": "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

An object that contains details for each member account.

Type: Array of Member objects

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

nextToken

The pagination parameter to be used on the next list operation to retrieve more items.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000000.

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed due to an internal failure of the Amazon Inspector service.

HTTP Status Code: 500

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request has failed validation due to missing required fields or having invalid inputs.

HTTP Status Code: 400