# GetSetupHistory


Returns detailed information for five of the most recent `SetupInstanceHttps` requests that were ran on the target instance.

## Request Syntax


```
{
   "pageToken": "string",
   "resourceName": "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.

 ** [pageToken](#API_GetSetupHistory_RequestSyntax) **   <a name="Lightsail-GetSetupHistory-request-pageToken"></a>
The token to advance to the next page of results from your request.  
To get a page token, perform an initial `GetSetupHistory` request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.  
Type: String  
Length Constraints: Minimum length of 24. Maximum length of 40.  
Pattern: `^[A-Za-z0-9+/=]+$`   
Required: No

 ** [resourceName](#API_GetSetupHistory_RequestSyntax) **   <a name="Lightsail-GetSetupHistory-request-resourceName"></a>
The name of the resource for which you are requesting information.  
Type: String  
Pattern: `\w[\w\-]*\w`   
Required: Yes

## Response Syntax


```
{
   "nextPageToken": "string",
   "setupHistory": [ 
      { 
         "executionDetails": [ 
            { 
               "command": "string",
               "dateTime": number,
               "name": "string",
               "standardError": "string",
               "standardOutput": "string",
               "status": "string",
               "version": "string"
            }
         ],
         "operationId": "string",
         "request": { 
            "certificateProvider": "string",
            "domainNames": [ "string" ],
            "instanceName": "string"
         },
         "resource": { 
            "arn": "string",
            "createdAt": number,
            "location": { 
               "availabilityZone": "string",
               "regionName": "string"
            },
            "name": "string",
            "resourceType": "string"
         },
         "status": "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.

 ** [nextPageToken](#API_GetSetupHistory_ResponseSyntax) **   <a name="Lightsail-GetSetupHistory-response-nextPageToken"></a>
The token to advance to the next page of results from your request.  
A next page token is not returned if there are no more results to display.  
To get the next page of results, perform another `GetSetupHistory` request and specify the next page token using the pageToken parameter.  
Type: String  
Length Constraints: Minimum length of 24. Maximum length of 40.  
Pattern: `^[A-Za-z0-9+/=]+$` 

 ** [setupHistory](#API_GetSetupHistory_ResponseSyntax) **   <a name="Lightsail-GetSetupHistory-response-setupHistory"></a>
The historical information that's returned.  
Type: Array of [SetupHistory](API_SetupHistory.md) objects

## 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

 ** 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

 ** 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/GetSetupHistory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetSetupHistory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetSetupHistory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetSetupHistory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetSetupHistory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetSetupHistory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetSetupHistory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetSetupHistory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetSetupHistory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetSetupHistory)