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

ListOrganizationAdminAccounts

Lists the accounts designated as GuardDuty delegated administrators. Only the organization's management account can run this API operation.

Request Syntax


GET /admin?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results to return in the response.

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

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. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "adminAccounts": [ 
      { 
         "adminAccountId": "string",
         "adminStatus": "string"
      }
   ],
   "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.

adminAccounts

A list of accounts configured as GuardDuty delegated administrators.

Type: Array of AdminAccount objects

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

nextToken

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

Type: String

Errors

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

BadRequestException

A bad request exception object.

Message: The error message.
Type: The error type.

HTTP Status Code: 400

InternalServerErrorException

An internal server error exception object.

Message: The error message.
Type: The error type.

HTTP Status Code: 500