# GetInstance
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
## Request Syntax
```
{
"instanceName": "string"
}
```
## Request Parameters
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.
** [instanceName](#API_GetInstance_RequestSyntax) **
The name of the instance.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
## Response Syntax
```
{
"instance": {
"addOns": [
{
"duration": "string",
"name": "string",
"nextSnapshotTimeOfDay": "string",
"snapshotTimeOfDay": "string",
"status": "string",
"threshold": "string"
}
],
"arn": "string",
"blueprintId": "string",
"blueprintName": "string",
"bundleId": "string",
"createdAt": number,
"hardware": {
"cpuCount": number,
"disks": [
{
"addOns": [
{
"duration": "string",
"name": "string",
"nextSnapshotTimeOfDay": "string",
"snapshotTimeOfDay": "string",
"status": "string",
"threshold": "string"
}
],
"arn": "string",
"attachedTo": "string",
"attachmentState": "string",
"autoMountStatus": "string",
"createdAt": number,
"gbInUse": number,
"iops": number,
"isAttached": boolean,
"isSystemDisk": boolean,
"location": {
"availabilityZone": "string",
"regionName": "string"
},
"name": "string",
"path": "string",
"resourceType": "string",
"sizeInGb": number,
"state": "string",
"supportCode": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
],
"ramSizeInGb": number
},
"ipAddressType": "string",
"ipv6Addresses": [ "string" ],
"isStaticIp": boolean,
"location": {
"availabilityZone": "string",
"regionName": "string"
},
"metadataOptions": {
"httpEndpoint": "string",
"httpProtocolIpv6": "string",
"httpPutResponseHopLimit": number,
"httpTokens": "string",
"state": "string"
},
"name": "string",
"networking": {
"monthlyTransfer": {
"gbPerMonthAllocated": number
},
"ports": [
{
"accessDirection": "string",
"accessFrom": "string",
"accessType": "string",
"cidrListAliases": [ "string" ],
"cidrs": [ "string" ],
"commonName": "string",
"fromPort": number,
"ipv6Cidrs": [ "string" ],
"protocol": "string",
"toPort": number
}
]
},
"privateIpAddress": "string",
"publicIpAddress": "string",
"resourceType": "string",
"sshKeyName": "string",
"state": {
"code": number,
"name": "string"
},
"supportCode": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"username": "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.
** [instance](#API_GetInstance_ResponseSyntax) **
An array of key-value pairs containing information about the specified instance.
Type: [Instance](API_Instance.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
HTTP Status Code: 400
** AccountSetupInProgressException **
Lightsail throws this exception when an account is still in the setup in progress state.
HTTP Status Code: 400
** InvalidInputException **
Lightsail throws this exception when user input does not conform to the validation rules of an input field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
HTTP Status Code: 400
** ServiceException **
A general service exception.
HTTP Status Code: 500
** UnauthenticatedException **
Lightsail throws this exception when the user has not been authenticated.
HTTP Status Code: 400
## See Also
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/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetInstance)