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

GetExperiment

Gets information about the specified experiment.

Request Syntax


GET /experiments/id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

id

The ID of the experiment.

Length Constraints: Maximum length of 64.

Pattern: [\S]+

Required: Yes

Request Body

The request does not have a request body.

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.

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ValidationException

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

HTTP Status Code: 400