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

ListGraphs

Returns the list of behavior graphs that the calling account is an administrator account of. This operation can only be called by an administrator account.

Because an account can currently only be the administrator of one behavior graph within a Region, the results always contain a single behavior graph.

Request Syntax


POST /graphs/list 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 graphs to return at a time. The total must be less than the overall limit on the number of results to return, which is currently 200.

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

{
   "GraphList": [ 
      { 
         "Arn": "string",
         "CreatedTime": "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.

GraphList

A list of behavior graphs that the account is an administrator account for.

Type: Array of Graph objects

NextToken

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

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

ValidationException

The request parameters are invalid.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of ListGraphs.

Sample Request


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

Example

This example illustrates one usage of ListGraphs.

Sample Response


HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 144
Date: Thu, 23 Jan 2020 23:07:46 GMT
x-amzn-RequestId: 397d0549-0092-11e8-a0ee-a7f9aa6e7572
Connection: Keep-alive

{
 "GraphList": [ 
 { 
  "Arn": "arn:aws:detective:us-east-1:111122223333:graph:027c7c4610ea4aacaf0b883093cab899",
  "CreatedTime": "2020-01-22T11:35:11.372Z"
 }
 ]
}