Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartExperiment

Starts running an experiment from the specified experiment template.

Request Syntax


POST /experiments HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "experimentOptions": { 
      "actionsMode": "string"
   },
   "experimentTemplateId": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\S]+

Required: Yes

experimentOptions

The experiment options for running the experiment.

Type: StartExperimentExperimentOptionsInput object

Required: No

experimentTemplateId

The ID of the experiment template.

Type: String

Length Constraints: Maximum length of 64.

Pattern: [\S]+

Required: Yes

tags

The tags to apply to the experiment.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Maximum length of 128.

Key Pattern: [\s\S]+

Value Length Constraints: Maximum length of 256.

Value Pattern: [\s\S]*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "experiment": { 
      "actions": { 
         "string" : { 
            "actionId": "string",
            "description": "string",
            "endTime": number,
            "parameters": { 
               "string" : "string" 
            },
            "startAfter": [ "string" ],
            "startTime": number,
            "state": { 
               "reason": "string",
               "status": "string"
            },
            "targets": { 
               "string" : "string" 
            }
         }
      },
      "arn": "string",
      "creationTime": number,
      "endTime": number,
      "experimentOptions": { 
         "accountTargeting": "string",
         "actionsMode": "string",
         "emptyTargetResolutionMode": "string"
      },
      "experimentReport": { 
         "s3Reports": [ 
            { 
               "arn": "string",
               "reportType": "string"
            }
         ],
         "state": { 
            "error": { 
               "code": "string"
            },
            "reason": "string",
            "status": "string"
         }
      },
      "experimentReportConfiguration": { 
         "dataSources": { 
            "cloudWatchDashboards": [ 
               { 
                  "dashboardIdentifier": "string"
               }
            ]
         },
         "outputs": { 
            "s3Configuration": { 
               "bucketName": "string",
               "prefix": "string"
            }
         },
         "postExperimentDuration": "string",
         "preExperimentDuration": "string"
      },
      "experimentTemplateId": "string",
      "id": "string",
      "logConfiguration": { 
         "cloudWatchLogsConfiguration": { 
            "logGroupArn": "string"
         },
         "logSchemaVersion": number,
         "s3Configuration": { 
            "bucketName": "string",
            "prefix": "string"
         }
      },
      "roleArn": "string",
      "startTime": number,
      "state": { 
         "error": { 
            "accountId": "string",
            "code": "string",
            "location": "string"
         },
         "reason": "string",
         "status": "string"
      },
      "stopConditions": [ 
         { 
            "source": "string",
            "value": "string"
         }
      ],
      "tags": { 
         "string" : "string" 
      },
      "targetAccountConfigurationsCount": number,
      "targets": { 
         "string" : { 
            "filters": [ 
               { 
                  "path": "string",
                  "values": [ "string" ]
               }
            ],
            "parameters": { 
               "string" : "string" 
            },
            "resourceArns": [ "string" ],
            "resourceTags": { 
               "string" : "string" 
            },
            "resourceType": "string",
            "selectionMode": "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.

experiment

Information about the experiment.

Type: Experiment object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

The request could not be processed because of a conflict.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ServiceQuotaExceededException

You have exceeded your service quota.

HTTP Status Code: 402

ValidationException

The specified input is not valid, or fails to satisfy the constraints for the request.

HTTP Status Code: 400