Detective / Client / list_graphs

list_graphs#

Detective.Client.list_graphs(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_graphs(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – 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.

  • MaxResults (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'GraphList': [
        {
            'Arn': 'string',
            'CreatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • GraphList (list) –

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

      • (dict) –

        A behavior graph in Detective.

        • Arn (string) –

          The ARN of the behavior graph.

        • CreatedTime (datetime) –

          The date and time that the behavior graph was created. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

    • NextToken (string) –

      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.

Exceptions

  • Detective.Client.exceptions.AccessDeniedException

  • Detective.Client.exceptions.InternalServerException

  • Detective.Client.exceptions.ValidationException