# ListExperiments
<a name="API_ListExperiments"></a>

Lists your experiments.

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

```
GET /experiments?experimentTemplateId=experimentTemplateId&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListExperiments_RequestParameters"></a>

The request uses the following URI parameters.

 ** [experimentTemplateId](#API_ListExperiments_RequestSyntax) **   <a name="fis-ListExperiments-request-uri-experimentTemplateId"></a>
The ID of the experiment template.  
Length Constraints: Maximum length of 64.  
Pattern: `[\S]+` 

 ** [maxResults](#API_ListExperiments_RequestSyntax) **   <a name="fis-ListExperiments-request-uri-maxResults"></a>
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListExperiments_RequestSyntax) **   <a name="fis-ListExperiments-request-uri-nextToken"></a>
The token for the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[\S]+` 

## Request Body
<a name="API_ListExperiments_RequestBody"></a>

The request does not have a request body.

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

```
HTTP/1.1 200
Content-type: application/json

{
   "experiments": [ 
      { 
         "arn": "string",
         "creationTime": number,
         "experimentOptions": { 
            "accountTargeting": "string",
            "actionsMode": "string",
            "emptyTargetResolutionMode": "string"
         },
         "experimentTemplateId": "string",
         "id": "string",
         "state": { 
            "error": { 
               "accountId": "string",
               "code": "string",
               "location": "string"
            },
            "reason": "string",
            "status": "string"
         },
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "nextToken": "string"
}
```

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

 ** [experiments](#API_ListExperiments_ResponseSyntax) **   <a name="fis-ListExperiments-response-experiments"></a>
The experiments.  
Type: Array of [ExperimentSummary](API_ExperimentSummary.md) objects

 ** [nextToken](#API_ListExperiments_ResponseSyntax) **   <a name="fis-ListExperiments-response-nextToken"></a>
The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[\S]+` 

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

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

 ** ValidationException **   
The specified input is not valid, or fails to satisfy the constraints for the request.  
HTTP Status Code: 400

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