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

ListOrganizationAdminAccounts

Returns information about the Detective administrator account for an organization. Can only be called by the organization management account.

Request Syntax


POST /orgs/adminAccountslist HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string"
}

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 to return.

Type: Integer

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

Required: No

NextToken

For requests to get the next page of results, the pagination token that was returned with the previous set of results. The initial request does not include a pagination token.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Administrators": [ 
      { 
         "AccountId": "string",
         "DelegationTime": "string",
         "GraphArn": "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.

Administrators

The list of Detective administrator accounts.

Type: Array of Administrator objects

NextToken

If there are more accounts remaining in the results, then this is the pagination token to use to request the next page of accounts.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Errors

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

AccessDeniedException

The request issuer does not have permission to access this resource or perform this operation.

HTTP Status Code: 403

InternalServerException

The request was valid but failed because of a problem with the service.

HTTP Status Code: 500

TooManyRequestsException

The request cannot be completed because too many other requests are occurring at the same time.

HTTP Status Code: 429

ValidationException

The request parameters are invalid.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of ListOrganizationAdminAccounts.

Sample Request


POST /orgs/adminAccountslist HTTP/1.1
Host: api.detective.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 0
Authorization: AUTHPARAMS
X-Amz-Date: 20210923T193018Z
User-Agent: aws-cli/1.14.29 Python/2.7.9 Windows/8 botocore/1.8.33

Example

This example illustrates one usage of ListOrganizationAdminAccounts.

Sample Response


HTTP/1.1 200 OK
Content-Length: 173
Date: Thu, 23 Sep 2021 23:07:46 GMT
x-amzn-RequestId: 397d0549-0092-11e8-a0ee-a7f9aa6e7572
Connection: Keep-alive

{
   "Administrators": [ 
      { 
         "AccountId": "111122223333",
         "DelegationTime": "2021-09-23T:14:17:40.812Z",
         "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:027c7c4610ea4aacaf0b883093cab899"
      }
   ]
}