# GetTool
<a name="API_GetTool"></a>

Retrieve a tool (optionally a specific version) by its id and versionId.

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

```
{
   "identifier": "string"
}
```

## Request Parameters
<a name="API_GetTool_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.

 ** [identifier](#API_GetTool_RequestSyntax) **   <a name="diagnostictools-GetTool-request-identifier"></a>
Version id for tool which your want information  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 2048.  
Required: Yes

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

```
{
   "tool": { 
      "id": "string",
      "latestVersionId": "string",
      "name": "string",
      "versions": [ 
         { 
            "description": "string",
            "labels": [ "string" ],
            "parametersSchema": "string",
            "usedFor": "string",
            "versionId": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_GetTool_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.

 ** [tool](#API_GetTool_ResponseSyntax) **   <a name="diagnostictools-GetTool-response-tool"></a>
Information about a Diagnostic Tool.  
Type: [Tool](API_Tool.md) object

## Errors
<a name="API_GetTool_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

 ** ResourceNotFoundException **   
The request failed because it references a resource that doesn't exist.    
 ** message **   
Reason for the resource not found.  
 ** resourceId **   
The unique ID of the resource referenced in the failed request.  
 ** resourceType **   
The resource type of the resource referenced in the failed request.
HTTP Status Code: 400

 ** 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_GetTool_Examples"></a>

This example illustrates one usage of `GetTool`.

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

 **Using AWS JSON protocol (default)** 

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

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

#### Sample Response
<a name="API_GetTool_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
{
    "tool": {
        "id": "EC2SystemsManager",
        "latestVersionId": "1.0.1",
        "name": "EC2 Systems Manager",
        "versions": [
            {
                "components": "",
                "description": "Lists the SSM Managed Instances, Activations, Maintenance Windows, Automation Executions, Patch Baselines, Patch Groups, Parameters and Documents",
                "parameters": "<Parameter Info>",
                "usedFor": "Investigating Systems Manager details (Managed Instances, Activations, Patch Groups, and more). on the account.",
                "versionId": "1.0.1"
            }
        ]
    }
}
```

## See Also
<a name="API_GetTool_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/GetTool) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/troubleshooting-2023-01-01/GetTool) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/troubleshooting-2023-01-01/GetTool) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/troubleshooting-2023-01-01/GetTool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/troubleshooting-2023-01-01/GetTool) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/troubleshooting-2023-01-01/GetTool) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/troubleshooting-2023-01-01/GetTool) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/troubleshooting-2023-01-01/GetTool) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/troubleshooting-2023-01-01/GetTool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/troubleshooting-2023-01-01/GetTool)