# ListTools
<a name="API_ListTools"></a>

List all of the available tools.

## Request Syntax
<a name="API_ListTools_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListTools_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListTools_RequestSyntax) **   <a name="diagnostictools-ListTools-request-maxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListTools_RequestSyntax) **   <a name="diagnostictools-ListTools-request-nextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Pattern: `[A-Za-z0-9\-_]*={0,3}`   
Required: No

## Response Syntax
<a name="API_ListTools_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "toolList": [ 
      { 
         "description": "string",
         "id": "string",
         "latestVersionId": "string",
         "name": "string",
         "usedFor": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTools_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListTools_ResponseSyntax) **   <a name="diagnostictools-ListTools-response-nextToken"></a>
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.   
Type: String  
Pattern: `[A-Za-z0-9\-_]*={0,3}` 

 ** [toolList](#API_ListTools_ResponseSyntax) **   <a name="diagnostictools-ListTools-response-toolList"></a>
Array of Tools objects  
Type: Array of [ToolSummary](API_ToolSummary.md) objects

## Errors
<a name="API_ListTools_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
User does not have sufficient access to perform this action.    
 ** message **   
Throttle error message.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed because of an internal error. Try your request again later    
 ** message **   
Error Message  
 ** retryAfterSeconds **   
Second after which client can retry the transaction
HTTP Status Code: 500

 ** ThrottlingException **   
The request failed because it exceeded a throttling quota.    
 ** message **   
Throttle error message.  
 ** quotaCode **   
The quota code recognized by the AWS Service Quotas service.  
 ** retryAfterSeconds **   
Second after which client can retry the transaction  
 ** serviceCode **   
The code for the AWS-service; that owns the quota.
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.    
 ** fieldList **   
The field that caused the error, if applicable. If more than one field caused the error, pick one and elaborate in the message.  
 ** message **   
Description of the error.  
 ** reason **   
Reason the request failed validation.
HTTP Status Code: 400

## Examples
<a name="API_ListTools_Examples"></a>

This example illustrates one usage of `ListTools`.

### Example
<a name="API_ListTools_Example_1"></a>

 **Using AWS JSON protocol (default)** 

#### Sample Request
<a name="API_ListTools_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ts.us-east-2.amazonaws.com
X-Amz-Target: Troubleshooting.ListTools
Content-Type: application/x-amz-json-1.0
X-Amz-Date: <Date>
Authorization: <AuthParams>
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
{
    "maxResults": 2
}
```

#### Sample Response
<a name="API_ListTools_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: <requestId>
Content-Length: 0
Date: <Date>
Content-Type: application/x-amz-json-1.0
{
    "nextToken": "nextTokenToRetrieveNextPage",
    "toolList": [
        {
            "id": "PinpointDashboard",
            "latestVersionId": "1.0.0",
            "name": "Pinpoint Dashboard",
            "usedFor": "Listing customer’s Pinpoint applications across regions.",
            "description": "Lists Pinpoint applications across regions.",
            },
            {
            "id": "CloudWatchLogGroupLookup",
            "latestVersionId": "1.0.1",
            "name": "CloudWatch LogGroup Lookup",
            "usedFor": "Investigating CloudWatch log groups using specified Log group name",
            "description": "Investigate CloudWatch log groups.",
            }
    ]
}
```

## See Also
<a name="API_ListTools_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/troubleshooting-2023-01-01/ListTools) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/troubleshooting-2023-01-01/ListTools) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/troubleshooting-2023-01-01/ListTools) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/troubleshooting-2023-01-01/ListTools) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/troubleshooting-2023-01-01/ListTools) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/troubleshooting-2023-01-01/ListTools) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/troubleshooting-2023-01-01/ListTools) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/troubleshooting-2023-01-01/ListTools) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/troubleshooting-2023-01-01/ListTools) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/troubleshooting-2023-01-01/ListTools)