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

UpdateExperimentTemplate

Updates the specified experiment template.

Request Syntax


PATCH /experimentTemplates/id HTTP/1.1
Content-type: application/json

{
   "actions": { 
      "string" : { 
         "actionId": "string",
         "description": "string",
         "parameters": { 
            "string" : "string" 
         },
         "startAfter": [ "string" ],
         "targets": { 
            "string" : "string" 
         }
      }
   },
   "description": "string",
   "experimentOptions": { 
      "emptyTargetResolutionMode": "string"
   },
   "logConfiguration": { 
      "cloudWatchLogsConfiguration": { 
         "logGroupArn": "string"
      },
      "logSchemaVersion": number,
      "s3Configuration": { 
         "bucketName": "string",
         "prefix": "string"
      }
   },
   "roleArn": "string",
   "stopConditions": [ 
      { 
         "source": "string",
         "value": "string"
      }
   ],
   "targets": { 
      "string" : { 
         "filters": [ 
            { 
               "path": "string",
               "values": [ "string" ]
            }
         ],
         "parameters": { 
            "string" : "string" 
         },
         "resourceArns": [ "string" ],
         "resourceTags": { 
            "string" : "string" 
         },
         "resourceType": "string",
         "selectionMode": "string"
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

id

The ID of the experiment template.

Length Constraints: Maximum length of 64.

Pattern: [\S]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

actions

The actions for the experiment.

Type: String to UpdateExperimentTemplateActionInputItem object map

Key Length Constraints: Maximum length of 64.

Key Pattern: [\S]+

Required: No

description

A description for the template.

Type: String

Length Constraints: Maximum length of 512.

Pattern: [\s\S]+

Required: No

experimentOptions

The experiment options for the experiment template.

Type: UpdateExperimentTemplateExperimentOptionsInput object

Required: No

logConfiguration

The configuration for experiment logging.

Type: UpdateExperimentTemplateLogConfigurationInput object

Required: No

roleArn

The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: [\S]+

Required: No

stopConditions

The stop conditions for the experiment.

Type: Array of UpdateExperimentTemplateStopConditionInput objects

Required: No

targets

The targets for the experiment.

Type: String to UpdateExperimentTemplateTargetInput object map

Key Length Constraints: Maximum length of 64.

Key Pattern: [\S]+

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "experimentTemplate": { 
      "actions": { 
         "string" : { 
            "actionId": "string",
            "description": "string",
            "parameters": { 
               "string" : "string" 
            },
            "startAfter": [ "string" ],
            "targets": { 
               "string" : "string" 
            }
         }
      },
      "arn": "string",
      "creationTime": number,
      "description": "string",
      "experimentOptions": { 
         "accountTargeting": "string",
         "emptyTargetResolutionMode": "string"
      },
      "id": "string",
      "lastUpdateTime": number,
      "logConfiguration": { 
         "cloudWatchLogsConfiguration": { 
            "logGroupArn": "string"
         },
         "logSchemaVersion": number,
         "s3Configuration": { 
            "bucketName": "string",
            "prefix": "string"
         }
      },
      "roleArn": "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.

experimentTemplate

Information about the experiment template.

Type: ExperimentTemplate 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

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