{ "version": "2.0", "metadata": { "apiVersion": "2020-12-01", "endpointPrefix": "fis", "jsonVersion": "1.1", "protocol": "rest-json", "protocols": [ "rest-json" ], "serviceAbbreviation": "FIS", "serviceFullName": "AWS Fault Injection Simulator", "serviceId": "fis", "signatureVersion": "v4", "signingName": "fis", "uid": "fis-2020-12-01", "auth": [ "aws.auth#sigv4" ] }, "operations": { "CreateExperimentTemplate": { "name": "CreateExperimentTemplate", "http": { "method": "POST", "requestUri": "/experimentTemplates", "responseCode": 200 }, "input": { "shape": "CreateExperimentTemplateRequest" }, "output": { "shape": "CreateExperimentTemplateResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ConflictException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ServiceQuotaExceededException" } ], "documentation": "
Creates an experiment template.
An experiment template includes the following components:
Targets: A target can be a specific resource in your Amazon Web Services environment, or one or more resources that match criteria that you specify, for example, resources that have specific tags.
Actions: The actions to carry out on the target. You can specify multiple actions, the duration of each action, and when to start each action during an experiment.
Stop conditions: If a stop condition is triggered while an experiment is running, the experiment is automatically stopped. You can define a stop condition as a CloudWatch alarm.
For more information, see experiment templates in the Fault Injection Service User Guide.
" }, "CreateTargetAccountConfiguration": { "name": "CreateTargetAccountConfiguration", "http": { "method": "POST", "requestUri": "/experimentTemplates/{id}/targetAccountConfigurations/{accountId}", "responseCode": 200 }, "input": { "shape": "CreateTargetAccountConfigurationRequest" }, "output": { "shape": "CreateTargetAccountConfigurationResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ConflictException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ServiceQuotaExceededException" } ], "documentation": "Creates a target account configuration for the experiment template. A target account configuration is required when accountTargeting
of experimentOptions
is set to multi-account
. For more information, see experiment options in the Fault Injection Service User Guide.
Deletes the specified experiment template.
" }, "DeleteTargetAccountConfiguration": { "name": "DeleteTargetAccountConfiguration", "http": { "method": "DELETE", "requestUri": "/experimentTemplates/{id}/targetAccountConfigurations/{accountId}", "responseCode": 200 }, "input": { "shape": "DeleteTargetAccountConfigurationRequest" }, "output": { "shape": "DeleteTargetAccountConfigurationResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Deletes the specified target account configuration of the experiment template.
" }, "GetAction": { "name": "GetAction", "http": { "method": "GET", "requestUri": "/actions/{id}", "responseCode": 200 }, "input": { "shape": "GetActionRequest" }, "output": { "shape": "GetActionResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Gets information about the specified FIS action.
" }, "GetExperiment": { "name": "GetExperiment", "http": { "method": "GET", "requestUri": "/experiments/{id}", "responseCode": 200 }, "input": { "shape": "GetExperimentRequest" }, "output": { "shape": "GetExperimentResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Gets information about the specified experiment.
" }, "GetExperimentTargetAccountConfiguration": { "name": "GetExperimentTargetAccountConfiguration", "http": { "method": "GET", "requestUri": "/experiments/{id}/targetAccountConfigurations/{accountId}", "responseCode": 200 }, "input": { "shape": "GetExperimentTargetAccountConfigurationRequest" }, "output": { "shape": "GetExperimentTargetAccountConfigurationResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" } ], "documentation": "Gets information about the specified target account configuration of the experiment.
" }, "GetExperimentTemplate": { "name": "GetExperimentTemplate", "http": { "method": "GET", "requestUri": "/experimentTemplates/{id}", "responseCode": 200 }, "input": { "shape": "GetExperimentTemplateRequest" }, "output": { "shape": "GetExperimentTemplateResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Gets information about the specified experiment template.
" }, "GetSafetyLever": { "name": "GetSafetyLever", "http": { "method": "GET", "requestUri": "/safetyLevers/{id}", "responseCode": 200 }, "input": { "shape": "GetSafetyLeverRequest" }, "output": { "shape": "GetSafetyLeverResponse" }, "errors": [ { "shape": "ResourceNotFoundException" } ], "documentation": "Gets information about the specified safety lever.
" }, "GetTargetAccountConfiguration": { "name": "GetTargetAccountConfiguration", "http": { "method": "GET", "requestUri": "/experimentTemplates/{id}/targetAccountConfigurations/{accountId}", "responseCode": 200 }, "input": { "shape": "GetTargetAccountConfigurationRequest" }, "output": { "shape": "GetTargetAccountConfigurationResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ValidationException" } ], "documentation": "Gets information about the specified target account configuration of the experiment template.
" }, "GetTargetResourceType": { "name": "GetTargetResourceType", "http": { "method": "GET", "requestUri": "/targetResourceTypes/{resourceType}", "responseCode": 200 }, "input": { "shape": "GetTargetResourceTypeRequest" }, "output": { "shape": "GetTargetResourceTypeResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Gets information about the specified resource type.
" }, "ListActions": { "name": "ListActions", "http": { "method": "GET", "requestUri": "/actions", "responseCode": 200 }, "input": { "shape": "ListActionsRequest" }, "output": { "shape": "ListActionsResponse" }, "errors": [ { "shape": "ValidationException" } ], "documentation": "Lists the available FIS actions.
" }, "ListExperimentResolvedTargets": { "name": "ListExperimentResolvedTargets", "http": { "method": "GET", "requestUri": "/experiments/{id}/resolvedTargets", "responseCode": 200 }, "input": { "shape": "ListExperimentResolvedTargetsRequest" }, "output": { "shape": "ListExperimentResolvedTargetsResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Lists the resolved targets information of the specified experiment.
" }, "ListExperimentTargetAccountConfigurations": { "name": "ListExperimentTargetAccountConfigurations", "http": { "method": "GET", "requestUri": "/experiments/{id}/targetAccountConfigurations", "responseCode": 200 }, "input": { "shape": "ListExperimentTargetAccountConfigurationsRequest" }, "output": { "shape": "ListExperimentTargetAccountConfigurationsResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Lists the target account configurations of the specified experiment.
" }, "ListExperimentTemplates": { "name": "ListExperimentTemplates", "http": { "method": "GET", "requestUri": "/experimentTemplates", "responseCode": 200 }, "input": { "shape": "ListExperimentTemplatesRequest" }, "output": { "shape": "ListExperimentTemplatesResponse" }, "errors": [ { "shape": "ValidationException" } ], "documentation": "Lists your experiment templates.
" }, "ListExperiments": { "name": "ListExperiments", "http": { "method": "GET", "requestUri": "/experiments", "responseCode": 200 }, "input": { "shape": "ListExperimentsRequest" }, "output": { "shape": "ListExperimentsResponse" }, "errors": [ { "shape": "ValidationException" } ], "documentation": "Lists your experiments.
" }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "GET", "requestUri": "/tags/{resourceArn}", "responseCode": 200 }, "input": { "shape": "ListTagsForResourceRequest" }, "output": { "shape": "ListTagsForResourceResponse" }, "documentation": "Lists the tags for the specified resource.
" }, "ListTargetAccountConfigurations": { "name": "ListTargetAccountConfigurations", "http": { "method": "GET", "requestUri": "/experimentTemplates/{id}/targetAccountConfigurations", "responseCode": 200 }, "input": { "shape": "ListTargetAccountConfigurationsRequest" }, "output": { "shape": "ListTargetAccountConfigurationsResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Lists the target account configurations of the specified experiment template.
" }, "ListTargetResourceTypes": { "name": "ListTargetResourceTypes", "http": { "method": "GET", "requestUri": "/targetResourceTypes", "responseCode": 200 }, "input": { "shape": "ListTargetResourceTypesRequest" }, "output": { "shape": "ListTargetResourceTypesResponse" }, "errors": [ { "shape": "ValidationException" } ], "documentation": "Lists the target resource types.
" }, "StartExperiment": { "name": "StartExperiment", "http": { "method": "POST", "requestUri": "/experiments", "responseCode": 200 }, "input": { "shape": "StartExperimentRequest" }, "output": { "shape": "StartExperimentResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ConflictException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ServiceQuotaExceededException" } ], "documentation": "Starts running an experiment from the specified experiment template.
" }, "StopExperiment": { "name": "StopExperiment", "http": { "method": "DELETE", "requestUri": "/experiments/{id}", "responseCode": 200 }, "input": { "shape": "StopExperimentRequest" }, "output": { "shape": "StopExperimentResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Stops the specified experiment.
" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/tags/{resourceArn}", "responseCode": 200 }, "input": { "shape": "TagResourceRequest" }, "output": { "shape": "TagResourceResponse" }, "documentation": "Applies the specified tags to the specified resource.
" }, "UntagResource": { "name": "UntagResource", "http": { "method": "DELETE", "requestUri": "/tags/{resourceArn}", "responseCode": 200 }, "input": { "shape": "UntagResourceRequest" }, "output": { "shape": "UntagResourceResponse" }, "documentation": "Removes the specified tags from the specified resource.
" }, "UpdateExperimentTemplate": { "name": "UpdateExperimentTemplate", "http": { "method": "PATCH", "requestUri": "/experimentTemplates/{id}", "responseCode": 200 }, "input": { "shape": "UpdateExperimentTemplateRequest" }, "output": { "shape": "UpdateExperimentTemplateResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ServiceQuotaExceededException" } ], "documentation": "Updates the specified experiment template.
" }, "UpdateSafetyLeverState": { "name": "UpdateSafetyLeverState", "http": { "method": "PATCH", "requestUri": "/safetyLevers/{id}/state", "responseCode": 200 }, "input": { "shape": "UpdateSafetyLeverStateRequest" }, "output": { "shape": "UpdateSafetyLeverStateResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ConflictException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Updates the specified safety lever state.
" }, "UpdateTargetAccountConfiguration": { "name": "UpdateTargetAccountConfiguration", "http": { "method": "PATCH", "requestUri": "/experimentTemplates/{id}/targetAccountConfigurations/{accountId}", "responseCode": 200 }, "input": { "shape": "UpdateTargetAccountConfigurationRequest" }, "output": { "shape": "UpdateTargetAccountConfigurationResponse" }, "errors": [ { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "Updates the target account configuration for the specified experiment template.
" } }, "shapes": { "AccountTargeting": { "type": "string", "enum": [ "single-account", "multi-account" ] }, "Action": { "type": "structure", "members": { "id": { "shape": "ActionId", "documentation": "The ID of the action.
" }, "arn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the action.
" }, "description": { "shape": "ActionDescription", "documentation": "The description for the action.
" }, "parameters": { "shape": "ActionParameterMap", "documentation": "The action parameters, if applicable.
" }, "targets": { "shape": "ActionTargetMap", "documentation": "The supported targets for the action.
" }, "tags": { "shape": "TagMap", "documentation": "The tags for the action.
" } }, "documentation": "Describes an action. For more information, see FIS actions in the Fault Injection Service User Guide.
" }, "ActionDescription": { "type": "string", "max": 512, "pattern": "[\\s\\S]+" }, "ActionId": { "type": "string", "max": 128, "pattern": "[\\S]+" }, "ActionParameter": { "type": "structure", "members": { "description": { "shape": "ActionParameterDescription", "documentation": "The parameter description.
" }, "required": { "shape": "ActionParameterRequired", "documentation": "Indicates whether the parameter is required.
", "box": true } }, "documentation": "Describes a parameter for an action.
" }, "ActionParameterDescription": { "type": "string", "max": 512, "pattern": "[\\s\\S]+" }, "ActionParameterMap": { "type": "map", "key": { "shape": "ActionParameterName" }, "value": { "shape": "ActionParameter" } }, "ActionParameterName": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "ActionParameterRequired": { "type": "boolean" }, "ActionSummary": { "type": "structure", "members": { "id": { "shape": "ActionId", "documentation": "The ID of the action.
" }, "arn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the action.
" }, "description": { "shape": "ActionDescription", "documentation": "The description for the action.
" }, "targets": { "shape": "ActionTargetMap", "documentation": "The targets for the action.
" }, "tags": { "shape": "TagMap", "documentation": "The tags for the action.
" } }, "documentation": "Provides a summary of an action.
" }, "ActionSummaryList": { "type": "list", "member": { "shape": "ActionSummary" } }, "ActionTarget": { "type": "structure", "members": { "resourceType": { "shape": "TargetResourceTypeId", "documentation": "The resource type of the target.
" } }, "documentation": "Describes a target for an action.
" }, "ActionTargetMap": { "type": "map", "key": { "shape": "ActionTargetName" }, "value": { "shape": "ActionTarget" } }, "ActionTargetName": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "ActionsMode": { "type": "string", "enum": [ "skip-all", "run-all" ] }, "ClientToken": { "type": "string", "max": 1024, "min": 1, "pattern": "[\\S]+" }, "CloudWatchLogGroupArn": { "type": "string", "max": 2048, "min": 20, "pattern": "[\\S]+" }, "CreateExperimentTemplateActionInput": { "type": "structure", "required": [ "actionId" ], "members": { "actionId": { "shape": "ActionId", "documentation": "The ID of the action. The format of the action ID is: aws:service-name:action-type.
" }, "description": { "shape": "ExperimentTemplateActionDescription", "documentation": "A description for the action.
" }, "parameters": { "shape": "ExperimentTemplateActionParameterMap", "documentation": "The parameters for the action, if applicable.
" }, "targets": { "shape": "ExperimentTemplateActionTargetMap", "documentation": "The targets for the action.
" }, "startAfter": { "shape": "ExperimentTemplateActionStartAfterList", "documentation": "The name of the action that must be completed before the current action starts. Omit this parameter to run the action at the start of the experiment.
" } }, "documentation": "Specifies an action for an experiment template.
For more information, see Actions in the Fault Injection Service User Guide.
" }, "CreateExperimentTemplateActionInputMap": { "type": "map", "key": { "shape": "ExperimentTemplateActionName" }, "value": { "shape": "CreateExperimentTemplateActionInput" } }, "CreateExperimentTemplateExperimentOptionsInput": { "type": "structure", "members": { "accountTargeting": { "shape": "AccountTargeting", "documentation": "Specifies the account targeting setting for experiment options.
" }, "emptyTargetResolutionMode": { "shape": "EmptyTargetResolutionMode", "documentation": "Specifies the empty target resolution mode for experiment options.
" } }, "documentation": "Specifies experiment options for an experiment template.
" }, "CreateExperimentTemplateLogConfigurationInput": { "type": "structure", "required": [ "logSchemaVersion" ], "members": { "cloudWatchLogsConfiguration": { "shape": "ExperimentTemplateCloudWatchLogsLogConfigurationInput", "documentation": "The configuration for experiment logging to Amazon CloudWatch Logs.
" }, "s3Configuration": { "shape": "ExperimentTemplateS3LogConfigurationInput", "documentation": "The configuration for experiment logging to Amazon S3.
" }, "logSchemaVersion": { "shape": "LogSchemaVersion", "documentation": "The schema version.
" } }, "documentation": "Specifies the configuration for experiment logging.
" }, "CreateExperimentTemplateRequest": { "type": "structure", "required": [ "clientToken", "description", "stopConditions", "actions", "roleArn" ], "members": { "clientToken": { "shape": "ClientToken", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "idempotencyToken": true }, "description": { "shape": "ExperimentTemplateDescription", "documentation": "A description for the experiment template.
" }, "stopConditions": { "shape": "CreateExperimentTemplateStopConditionInputList", "documentation": "The stop conditions.
" }, "targets": { "shape": "CreateExperimentTemplateTargetInputMap", "documentation": "The targets for the experiment.
" }, "actions": { "shape": "CreateExperimentTemplateActionInputMap", "documentation": "The actions for the experiment.
" }, "roleArn": { "shape": "RoleArn", "documentation": "The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
" }, "tags": { "shape": "TagMap", "documentation": "The tags to apply to the experiment template.
" }, "logConfiguration": { "shape": "CreateExperimentTemplateLogConfigurationInput", "documentation": "The configuration for experiment logging.
" }, "experimentOptions": { "shape": "CreateExperimentTemplateExperimentOptionsInput", "documentation": "The experiment options for the experiment template.
" } } }, "CreateExperimentTemplateResponse": { "type": "structure", "members": { "experimentTemplate": { "shape": "ExperimentTemplate", "documentation": "Information about the experiment template.
" } } }, "CreateExperimentTemplateStopConditionInput": { "type": "structure", "required": [ "source" ], "members": { "source": { "shape": "StopConditionSource", "documentation": "The source for the stop condition. Specify aws:cloudwatch:alarm
if the stop condition is defined by a CloudWatch alarm. Specify none
if there is no stop condition.
The Amazon Resource Name (ARN) of the CloudWatch alarm. This is required if the source is a CloudWatch alarm.
" } }, "documentation": "Specifies a stop condition for an experiment template.
" }, "CreateExperimentTemplateStopConditionInputList": { "type": "list", "member": { "shape": "CreateExperimentTemplateStopConditionInput" } }, "CreateExperimentTemplateTargetInput": { "type": "structure", "required": [ "resourceType", "selectionMode" ], "members": { "resourceType": { "shape": "TargetResourceTypeId", "documentation": "The resource type. The resource type must be supported for the specified action.
" }, "resourceArns": { "shape": "ResourceArnList", "documentation": "The Amazon Resource Names (ARNs) of the resources.
" }, "resourceTags": { "shape": "TagMap", "documentation": "The tags for the target resources.
" }, "filters": { "shape": "ExperimentTemplateTargetFilterInputList", "documentation": "The filters to apply to identify target resources using specific attributes.
" }, "selectionMode": { "shape": "ExperimentTemplateTargetSelectionMode", "documentation": "Scopes the identified resources to a specific count of the resources at random, or a percentage of the resources. All identified resources are included in the target.
ALL - Run the action on all identified targets. This is the default.
COUNT(n) - Run the action on the specified number of targets, chosen from the identified targets at random. For example, COUNT(1) selects one of the targets.
PERCENT(n) - Run the action on the specified percentage of targets, chosen from the identified targets at random. For example, PERCENT(25) selects 25% of the targets.
The resource type parameters.
" } }, "documentation": "Specifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or at least one resource tag. You cannot specify both ARNs and tags.
For more information, see Targets in the Fault Injection Service User Guide.
" }, "CreateExperimentTemplateTargetInputMap": { "type": "map", "key": { "shape": "ExperimentTemplateTargetName" }, "value": { "shape": "CreateExperimentTemplateTargetInput" } }, "CreateTargetAccountConfigurationRequest": { "type": "structure", "required": [ "experimentTemplateId", "accountId", "roleArn" ], "members": { "clientToken": { "shape": "ClientToken", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "idempotencyToken": true }, "experimentTemplateId": { "shape": "ExperimentTemplateId", "documentation": "The experiment template ID.
", "location": "uri", "locationName": "id" }, "accountId": { "shape": "TargetAccountId", "documentation": "The Amazon Web Services account ID of the target account.
", "location": "uri", "locationName": "accountId" }, "roleArn": { "shape": "RoleArn", "documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
" }, "description": { "shape": "TargetAccountConfigurationDescription", "documentation": "The description of the target account.
" } } }, "CreateTargetAccountConfigurationResponse": { "type": "structure", "members": { "targetAccountConfiguration": { "shape": "TargetAccountConfiguration", "documentation": "Information about the target account configuration.
" } } }, "CreationTime": { "type": "timestamp" }, "DeleteExperimentTemplateRequest": { "type": "structure", "required": [ "id" ], "members": { "id": { "shape": "ExperimentTemplateId", "documentation": "The ID of the experiment template.
", "location": "uri", "locationName": "id" } } }, "DeleteExperimentTemplateResponse": { "type": "structure", "members": { "experimentTemplate": { "shape": "ExperimentTemplate", "documentation": "Information about the experiment template.
" } } }, "DeleteTargetAccountConfigurationRequest": { "type": "structure", "required": [ "experimentTemplateId", "accountId" ], "members": { "experimentTemplateId": { "shape": "ExperimentTemplateId", "documentation": "The ID of the experiment template.
", "location": "uri", "locationName": "id" }, "accountId": { "shape": "TargetAccountId", "documentation": "The Amazon Web Services account ID of the target account.
", "location": "uri", "locationName": "accountId" } } }, "DeleteTargetAccountConfigurationResponse": { "type": "structure", "members": { "targetAccountConfiguration": { "shape": "TargetAccountConfiguration", "documentation": "Information about the target account configuration.
" } } }, "EmptyTargetResolutionMode": { "type": "string", "enum": [ "fail", "skip" ] }, "Experiment": { "type": "structure", "members": { "id": { "shape": "ExperimentId", "documentation": "The ID of the experiment.
" }, "arn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the experiment.
" }, "experimentTemplateId": { "shape": "ExperimentTemplateId", "documentation": "The ID of the experiment template.
" }, "roleArn": { "shape": "RoleArn", "documentation": "The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
" }, "state": { "shape": "ExperimentState", "documentation": "The state of the experiment.
" }, "targets": { "shape": "ExperimentTargetMap", "documentation": "The targets for the experiment.
" }, "actions": { "shape": "ExperimentActionMap", "documentation": "The actions for the experiment.
" }, "stopConditions": { "shape": "ExperimentStopConditionList", "documentation": "The stop conditions for the experiment.
" }, "creationTime": { "shape": "CreationTime", "documentation": "The time that the experiment was created.
" }, "startTime": { "shape": "ExperimentStartTime", "documentation": "The time that the experiment started.
" }, "endTime": { "shape": "ExperimentEndTime", "documentation": "The time that the experiment ended.
" }, "tags": { "shape": "TagMap", "documentation": "The tags for the experiment.
" }, "logConfiguration": { "shape": "ExperimentLogConfiguration", "documentation": "The configuration for experiment logging.
" }, "experimentOptions": { "shape": "ExperimentOptions", "documentation": "The experiment options for the experiment.
" }, "targetAccountConfigurationsCount": { "shape": "TargetAccountConfigurationsCount", "documentation": "The count of target account configurations for the experiment.
" } }, "documentation": "Describes an experiment.
" }, "ExperimentAction": { "type": "structure", "members": { "actionId": { "shape": "ActionId", "documentation": "The ID of the action.
" }, "description": { "shape": "ExperimentActionDescription", "documentation": "The description for the action.
" }, "parameters": { "shape": "ExperimentActionParameterMap", "documentation": "The parameters for the action.
" }, "targets": { "shape": "ExperimentActionTargetMap", "documentation": "The targets for the action.
" }, "startAfter": { "shape": "ExperimentActionStartAfterList", "documentation": "The name of the action that must be completed before this action starts.
" }, "state": { "shape": "ExperimentActionState", "documentation": "The state of the action.
" }, "startTime": { "shape": "ExperimentActionStartTime", "documentation": "The time that the action started.
" }, "endTime": { "shape": "ExperimentActionEndTime", "documentation": "The time that the action ended.
" } }, "documentation": "Describes the action for an experiment.
" }, "ExperimentActionDescription": { "type": "string", "max": 512, "pattern": "[\\s\\S]+" }, "ExperimentActionEndTime": { "type": "timestamp" }, "ExperimentActionMap": { "type": "map", "key": { "shape": "ExperimentActionName" }, "value": { "shape": "ExperimentAction" } }, "ExperimentActionName": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "ExperimentActionParameter": { "type": "string", "max": 1024, "pattern": "[\\S]+" }, "ExperimentActionParameterMap": { "type": "map", "key": { "shape": "ExperimentActionParameterName" }, "value": { "shape": "ExperimentActionParameter" } }, "ExperimentActionParameterName": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "ExperimentActionStartAfter": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "ExperimentActionStartAfterList": { "type": "list", "member": { "shape": "ExperimentActionStartAfter" } }, "ExperimentActionStartTime": { "type": "timestamp" }, "ExperimentActionState": { "type": "structure", "members": { "status": { "shape": "ExperimentActionStatus", "documentation": "The state of the action.
" }, "reason": { "shape": "ExperimentActionStatusReason", "documentation": "The reason for the state.
" } }, "documentation": "Describes the state of an action.
" }, "ExperimentActionStatus": { "type": "string", "enum": [ "pending", "initiating", "running", "completed", "cancelled", "stopping", "stopped", "failed", "skipped" ] }, "ExperimentActionStatusReason": { "type": "string", "max": 512, "pattern": "[\\s\\S]+" }, "ExperimentActionTargetMap": { "type": "map", "key": { "shape": "ExperimentActionTargetName" }, "value": { "shape": "ExperimentTargetName" } }, "ExperimentActionTargetName": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "ExperimentCloudWatchLogsLogConfiguration": { "type": "structure", "members": { "logGroupArn": { "shape": "CloudWatchLogGroupArn", "documentation": "The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
" } }, "documentation": "Describes the configuration for experiment logging to Amazon CloudWatch Logs.
" }, "ExperimentEndTime": { "type": "timestamp" }, "ExperimentError": { "type": "structure", "members": { "accountId": { "shape": "ExperimentErrorAccountId", "documentation": "The Amazon Web Services Account ID where the experiment failure occurred.
" }, "code": { "shape": "ExperimentErrorCode", "documentation": "The error code for the failed experiment.
" }, "location": { "shape": "ExperimentErrorLocation", "documentation": "Context for the section of the experiment template that failed.
" } }, "documentation": "Describes the error when an experiment has failed
.
The configuration for experiment logging to Amazon CloudWatch Logs.
" }, "s3Configuration": { "shape": "ExperimentS3LogConfiguration", "documentation": "The configuration for experiment logging to Amazon S3.
" }, "logSchemaVersion": { "shape": "LogSchemaVersion", "documentation": "The schema version.
" } }, "documentation": "Describes the configuration for experiment logging.
" }, "ExperimentOptions": { "type": "structure", "members": { "accountTargeting": { "shape": "AccountTargeting", "documentation": "The account targeting setting for an experiment.
" }, "emptyTargetResolutionMode": { "shape": "EmptyTargetResolutionMode", "documentation": "The empty target resolution mode for an experiment.
" }, "actionsMode": { "shape": "ActionsMode", "documentation": "The actions mode of the experiment that is set from the StartExperiment API command.
" } }, "documentation": "Describes the options for an experiment.
" }, "ExperimentS3LogConfiguration": { "type": "structure", "members": { "bucketName": { "shape": "S3BucketName", "documentation": "The name of the destination bucket.
" }, "prefix": { "shape": "S3ObjectKey", "documentation": "The bucket prefix.
" } }, "documentation": "Describes the configuration for experiment logging to Amazon S3.
" }, "ExperimentStartTime": { "type": "timestamp" }, "ExperimentState": { "type": "structure", "members": { "status": { "shape": "ExperimentStatus", "documentation": "The state of the experiment.
" }, "reason": { "shape": "ExperimentStatusReason", "documentation": "The reason for the state.
" }, "error": { "shape": "ExperimentError", "documentation": "The error information of the experiment when the action has failed
.
Describes the state of an experiment.
" }, "ExperimentStatus": { "type": "string", "enum": [ "pending", "initiating", "running", "completed", "stopping", "stopped", "failed", "cancelled" ] }, "ExperimentStatusReason": { "type": "string", "max": 512, "pattern": "[\\s\\S]+" }, "ExperimentStopCondition": { "type": "structure", "members": { "source": { "shape": "StopConditionSource", "documentation": "The source for the stop condition.
" }, "value": { "shape": "StopConditionValue", "documentation": "The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
" } }, "documentation": "Describes the stop condition for an experiment.
" }, "ExperimentStopConditionList": { "type": "list", "member": { "shape": "ExperimentStopCondition" } }, "ExperimentSummary": { "type": "structure", "members": { "id": { "shape": "ExperimentId", "documentation": "The ID of the experiment.
" }, "arn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the experiment.
" }, "experimentTemplateId": { "shape": "ExperimentTemplateId", "documentation": "The ID of the experiment template.
" }, "state": { "shape": "ExperimentState", "documentation": "The state of the experiment.
" }, "creationTime": { "shape": "CreationTime", "documentation": "The time that the experiment was created.
" }, "tags": { "shape": "TagMap", "documentation": "The tags for the experiment.
" }, "experimentOptions": { "shape": "ExperimentOptions", "documentation": "The experiment options for the experiment.
" } }, "documentation": "Provides a summary of an experiment.
" }, "ExperimentSummaryList": { "type": "list", "member": { "shape": "ExperimentSummary" } }, "ExperimentTarget": { "type": "structure", "members": { "resourceType": { "shape": "TargetResourceTypeId", "documentation": "The resource type.
" }, "resourceArns": { "shape": "ResourceArnList", "documentation": "The Amazon Resource Names (ARNs) of the resources.
" }, "resourceTags": { "shape": "TagMap", "documentation": "The tags for the target resources.
" }, "filters": { "shape": "ExperimentTargetFilterList", "documentation": "The filters to apply to identify target resources using specific attributes.
" }, "selectionMode": { "shape": "ExperimentTargetSelectionMode", "documentation": "Scopes the identified resources to a specific count or percentage.
" }, "parameters": { "shape": "ExperimentTargetParameterMap", "documentation": "The resource type parameters.
" } }, "documentation": "Describes a target for an experiment.
" }, "ExperimentTargetAccountConfiguration": { "type": "structure", "members": { "roleArn": { "shape": "RoleArn", "documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
" }, "accountId": { "shape": "TargetAccountId", "documentation": "The Amazon Web Services account ID of the target account.
" }, "description": { "shape": "TargetAccountConfigurationDescription", "documentation": "The description of the target account.
" } }, "documentation": "Describes a target account configuration for an experiment.
" }, "ExperimentTargetAccountConfigurationList": { "type": "list", "member": { "shape": "ExperimentTargetAccountConfigurationSummary" } }, "ExperimentTargetAccountConfigurationSummary": { "type": "structure", "members": { "roleArn": { "shape": "RoleArn", "documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
" }, "accountId": { "shape": "TargetAccountId", "documentation": "The Amazon Web Services account ID of the target account.
" }, "description": { "shape": "TargetAccountConfigurationDescription", "documentation": "The description of the target account.
" } }, "documentation": "Provides a summary of a target account configuration.
" }, "ExperimentTargetFilter": { "type": "structure", "members": { "path": { "shape": "ExperimentTargetFilterPath", "documentation": "The attribute path for the filter.
" }, "values": { "shape": "ExperimentTargetFilterValues", "documentation": "The attribute values for the filter.
" } }, "documentation": "Describes a filter used for the target resources in an experiment.
" }, "ExperimentTargetFilterList": { "type": "list", "member": { "shape": "ExperimentTargetFilter" } }, "ExperimentTargetFilterPath": { "type": "string", "max": 256, "pattern": "[\\S]+" }, "ExperimentTargetFilterValue": { "type": "string", "max": 128, "pattern": "[\\S]+" }, "ExperimentTargetFilterValues": { "type": "list", "member": { "shape": "ExperimentTargetFilterValue" } }, "ExperimentTargetMap": { "type": "map", "key": { "shape": "ExperimentTargetName" }, "value": { "shape": "ExperimentTarget" } }, "ExperimentTargetName": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "ExperimentTargetParameterMap": { "type": "map", "key": { "shape": "ExperimentTargetParameterName" }, "value": { "shape": "ExperimentTargetParameterValue" } }, "ExperimentTargetParameterName": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "ExperimentTargetParameterValue": { "type": "string", "max": 1024, "min": 1 }, "ExperimentTargetSelectionMode": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "ExperimentTemplate": { "type": "structure", "members": { "id": { "shape": "ExperimentTemplateId", "documentation": "The ID of the experiment template.
" }, "arn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the experiment template.
" }, "description": { "shape": "ExperimentTemplateDescription", "documentation": "The description for the experiment template.
" }, "targets": { "shape": "ExperimentTemplateTargetMap", "documentation": "The targets for the experiment.
" }, "actions": { "shape": "ExperimentTemplateActionMap", "documentation": "The actions for the experiment.
" }, "stopConditions": { "shape": "ExperimentTemplateStopConditionList", "documentation": "The stop conditions for the experiment.
" }, "creationTime": { "shape": "CreationTime", "documentation": "The time the experiment template was created.
" }, "lastUpdateTime": { "shape": "LastUpdateTime", "documentation": "The time the experiment template was last updated.
" }, "roleArn": { "shape": "RoleArn", "documentation": "The Amazon Resource Name (ARN) of an IAM role.
" }, "tags": { "shape": "TagMap", "documentation": "The tags for the experiment template.
" }, "logConfiguration": { "shape": "ExperimentTemplateLogConfiguration", "documentation": "The configuration for experiment logging.
" }, "experimentOptions": { "shape": "ExperimentTemplateExperimentOptions", "documentation": "The experiment options for an experiment template.
" }, "targetAccountConfigurationsCount": { "shape": "TargetAccountConfigurationsCount", "documentation": "The count of target account configurations for the experiment template.
" } }, "documentation": "Describes an experiment template.
" }, "ExperimentTemplateAction": { "type": "structure", "members": { "actionId": { "shape": "ActionId", "documentation": "The ID of the action.
" }, "description": { "shape": "ExperimentTemplateActionDescription", "documentation": "A description for the action.
" }, "parameters": { "shape": "ExperimentTemplateActionParameterMap", "documentation": "The parameters for the action.
" }, "targets": { "shape": "ExperimentTemplateActionTargetMap", "documentation": "The targets for the action.
" }, "startAfter": { "shape": "ExperimentTemplateActionStartAfterList", "documentation": "The name of the action that must be completed before the current action starts.
" } }, "documentation": "Describes an action for an experiment template.
" }, "ExperimentTemplateActionDescription": { "type": "string", "max": 512, "pattern": "[\\s\\S]+" }, "ExperimentTemplateActionMap": { "type": "map", "key": { "shape": "ExperimentTemplateActionName" }, "value": { "shape": "ExperimentTemplateAction" } }, "ExperimentTemplateActionName": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "ExperimentTemplateActionParameter": { "type": "string", "max": 1024, "pattern": "[\\S]+" }, "ExperimentTemplateActionParameterMap": { "type": "map", "key": { "shape": "ExperimentTemplateActionParameterName" }, "value": { "shape": "ExperimentTemplateActionParameter" } }, "ExperimentTemplateActionParameterName": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "ExperimentTemplateActionStartAfter": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "ExperimentTemplateActionStartAfterList": { "type": "list", "member": { "shape": "ExperimentTemplateActionStartAfter" } }, "ExperimentTemplateActionTargetMap": { "type": "map", "key": { "shape": "ExperimentTemplateActionTargetName" }, "value": { "shape": "ExperimentTemplateTargetName" } }, "ExperimentTemplateActionTargetName": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "ExperimentTemplateCloudWatchLogsLogConfiguration": { "type": "structure", "members": { "logGroupArn": { "shape": "CloudWatchLogGroupArn", "documentation": "The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
" } }, "documentation": "Describes the configuration for experiment logging to Amazon CloudWatch Logs.
" }, "ExperimentTemplateCloudWatchLogsLogConfigurationInput": { "type": "structure", "required": [ "logGroupArn" ], "members": { "logGroupArn": { "shape": "CloudWatchLogGroupArn", "documentation": "The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
" } }, "documentation": "Specifies the configuration for experiment logging to Amazon CloudWatch Logs.
" }, "ExperimentTemplateDescription": { "type": "string", "max": 512, "pattern": "[\\s\\S]+" }, "ExperimentTemplateExperimentOptions": { "type": "structure", "members": { "accountTargeting": { "shape": "AccountTargeting", "documentation": "The account targeting setting for an experiment template.
" }, "emptyTargetResolutionMode": { "shape": "EmptyTargetResolutionMode", "documentation": "The empty target resolution mode for an experiment template.
" } }, "documentation": "Describes the experiment options for an experiment template.
" }, "ExperimentTemplateId": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "ExperimentTemplateLogConfiguration": { "type": "structure", "members": { "cloudWatchLogsConfiguration": { "shape": "ExperimentTemplateCloudWatchLogsLogConfiguration", "documentation": "The configuration for experiment logging to Amazon CloudWatch Logs.
" }, "s3Configuration": { "shape": "ExperimentTemplateS3LogConfiguration", "documentation": "The configuration for experiment logging to Amazon S3.
" }, "logSchemaVersion": { "shape": "LogSchemaVersion", "documentation": "The schema version.
" } }, "documentation": "Describes the configuration for experiment logging.
" }, "ExperimentTemplateS3LogConfiguration": { "type": "structure", "members": { "bucketName": { "shape": "S3BucketName", "documentation": "The name of the destination bucket.
" }, "prefix": { "shape": "S3ObjectKey", "documentation": "The bucket prefix.
" } }, "documentation": "Describes the configuration for experiment logging to Amazon S3.
" }, "ExperimentTemplateS3LogConfigurationInput": { "type": "structure", "required": [ "bucketName" ], "members": { "bucketName": { "shape": "S3BucketName", "documentation": "The name of the destination bucket.
" }, "prefix": { "shape": "S3ObjectKey", "documentation": "The bucket prefix.
" } }, "documentation": "Specifies the configuration for experiment logging to Amazon S3.
" }, "ExperimentTemplateStopCondition": { "type": "structure", "members": { "source": { "shape": "StopConditionSource", "documentation": "The source for the stop condition.
" }, "value": { "shape": "StopConditionValue", "documentation": "The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
" } }, "documentation": "Describes a stop condition for an experiment template.
" }, "ExperimentTemplateStopConditionList": { "type": "list", "member": { "shape": "ExperimentTemplateStopCondition" } }, "ExperimentTemplateSummary": { "type": "structure", "members": { "id": { "shape": "ExperimentTemplateId", "documentation": "The ID of the experiment template.
" }, "arn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the experiment template.
" }, "description": { "shape": "ExperimentTemplateDescription", "documentation": "The description of the experiment template.
" }, "creationTime": { "shape": "CreationTime", "documentation": "The time that the experiment template was created.
" }, "lastUpdateTime": { "shape": "LastUpdateTime", "documentation": "The time that the experiment template was last updated.
" }, "tags": { "shape": "TagMap", "documentation": "The tags for the experiment template.
" } }, "documentation": "Provides a summary of an experiment template.
" }, "ExperimentTemplateSummaryList": { "type": "list", "member": { "shape": "ExperimentTemplateSummary" } }, "ExperimentTemplateTarget": { "type": "structure", "members": { "resourceType": { "shape": "TargetResourceTypeId", "documentation": "The resource type.
" }, "resourceArns": { "shape": "ResourceArnList", "documentation": "The Amazon Resource Names (ARNs) of the targets.
" }, "resourceTags": { "shape": "TagMap", "documentation": "The tags for the target resources.
" }, "filters": { "shape": "ExperimentTemplateTargetFilterList", "documentation": "The filters to apply to identify target resources using specific attributes.
" }, "selectionMode": { "shape": "ExperimentTemplateTargetSelectionMode", "documentation": "Scopes the identified resources to a specific count or percentage.
" }, "parameters": { "shape": "ExperimentTemplateTargetParameterMap", "documentation": "The resource type parameters.
" } }, "documentation": "Describes a target for an experiment template.
" }, "ExperimentTemplateTargetFilter": { "type": "structure", "members": { "path": { "shape": "ExperimentTemplateTargetFilterPath", "documentation": "The attribute path for the filter.
" }, "values": { "shape": "ExperimentTemplateTargetFilterValues", "documentation": "The attribute values for the filter.
" } }, "documentation": "Describes a filter used for the target resources in an experiment template.
" }, "ExperimentTemplateTargetFilterInputList": { "type": "list", "member": { "shape": "ExperimentTemplateTargetInputFilter" } }, "ExperimentTemplateTargetFilterList": { "type": "list", "member": { "shape": "ExperimentTemplateTargetFilter" } }, "ExperimentTemplateTargetFilterPath": { "type": "string", "max": 256, "pattern": "[\\S]+" }, "ExperimentTemplateTargetFilterValue": { "type": "string", "max": 128, "pattern": "[\\S]+" }, "ExperimentTemplateTargetFilterValues": { "type": "list", "member": { "shape": "ExperimentTemplateTargetFilterValue" } }, "ExperimentTemplateTargetInputFilter": { "type": "structure", "required": [ "path", "values" ], "members": { "path": { "shape": "ExperimentTemplateTargetFilterPath", "documentation": "The attribute path for the filter.
" }, "values": { "shape": "ExperimentTemplateTargetFilterValues", "documentation": "The attribute values for the filter.
" } }, "documentation": "Specifies a filter used for the target resource input in an experiment template.
For more information, see Resource filters in the Fault Injection Service User Guide.
" }, "ExperimentTemplateTargetMap": { "type": "map", "key": { "shape": "ExperimentTemplateTargetName" }, "value": { "shape": "ExperimentTemplateTarget" } }, "ExperimentTemplateTargetName": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "ExperimentTemplateTargetParameterMap": { "type": "map", "key": { "shape": "ExperimentTemplateTargetParameterName" }, "value": { "shape": "ExperimentTemplateTargetParameterValue" } }, "ExperimentTemplateTargetParameterName": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "ExperimentTemplateTargetParameterValue": { "type": "string", "max": 1024, "min": 1, "pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+$" }, "ExperimentTemplateTargetSelectionMode": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "GetActionRequest": { "type": "structure", "required": [ "id" ], "members": { "id": { "shape": "ActionId", "documentation": "The ID of the action.
", "location": "uri", "locationName": "id" } } }, "GetActionResponse": { "type": "structure", "members": { "action": { "shape": "Action", "documentation": "Information about the action.
" } } }, "GetExperimentRequest": { "type": "structure", "required": [ "id" ], "members": { "id": { "shape": "ExperimentId", "documentation": "The ID of the experiment.
", "location": "uri", "locationName": "id" } } }, "GetExperimentResponse": { "type": "structure", "members": { "experiment": { "shape": "Experiment", "documentation": "Information about the experiment.
" } } }, "GetExperimentTargetAccountConfigurationRequest": { "type": "structure", "required": [ "experimentId", "accountId" ], "members": { "experimentId": { "shape": "ExperimentId", "documentation": "The ID of the experiment.
", "location": "uri", "locationName": "id" }, "accountId": { "shape": "TargetAccountId", "documentation": "The Amazon Web Services account ID of the target account.
", "location": "uri", "locationName": "accountId" } } }, "GetExperimentTargetAccountConfigurationResponse": { "type": "structure", "members": { "targetAccountConfiguration": { "shape": "ExperimentTargetAccountConfiguration", "documentation": "Information about the target account configuration.
" } } }, "GetExperimentTemplateRequest": { "type": "structure", "required": [ "id" ], "members": { "id": { "shape": "ExperimentTemplateId", "documentation": "The ID of the experiment template.
", "location": "uri", "locationName": "id" } } }, "GetExperimentTemplateResponse": { "type": "structure", "members": { "experimentTemplate": { "shape": "ExperimentTemplate", "documentation": "Information about the experiment template.
" } } }, "GetSafetyLeverRequest": { "type": "structure", "required": [ "id" ], "members": { "id": { "shape": "SafetyLeverId", "documentation": "The ID of the safety lever.
", "location": "uri", "locationName": "id" } } }, "GetSafetyLeverResponse": { "type": "structure", "members": { "safetyLever": { "shape": "SafetyLever", "documentation": "Information about the safety lever.
" } } }, "GetTargetAccountConfigurationRequest": { "type": "structure", "required": [ "experimentTemplateId", "accountId" ], "members": { "experimentTemplateId": { "shape": "ExperimentTemplateId", "documentation": "The ID of the experiment template.
", "location": "uri", "locationName": "id" }, "accountId": { "shape": "TargetAccountId", "documentation": "The Amazon Web Services account ID of the target account.
", "location": "uri", "locationName": "accountId" } } }, "GetTargetAccountConfigurationResponse": { "type": "structure", "members": { "targetAccountConfiguration": { "shape": "TargetAccountConfiguration", "documentation": "Information about the target account configuration.
" } } }, "GetTargetResourceTypeRequest": { "type": "structure", "required": [ "resourceType" ], "members": { "resourceType": { "shape": "TargetResourceTypeId", "documentation": "The resource type.
", "location": "uri", "locationName": "resourceType" } } }, "GetTargetResourceTypeResponse": { "type": "structure", "members": { "targetResourceType": { "shape": "TargetResourceType", "documentation": "Information about the resource type.
" } } }, "LastUpdateTime": { "type": "timestamp" }, "ListActionsMaxResults": { "type": "integer", "max": 100, "min": 1 }, "ListActionsRequest": { "type": "structure", "members": { "maxResults": { "shape": "ListActionsMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The token for the next page of results.
", "location": "querystring", "locationName": "nextToken" } } }, "ListActionsResponse": { "type": "structure", "members": { "actions": { "shape": "ActionSummaryList", "documentation": "The actions.
" }, "nextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The ID of the experiment.
", "location": "uri", "locationName": "id" }, "maxResults": { "shape": "ListExperimentResolvedTargetsMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
", "location": "querystring", "locationName": "maxResults" }, "nextToken": { "shape": "NextToken", "documentation": "The token for the next page of results.
", "location": "querystring", "locationName": "nextToken" }, "targetName": { "shape": "TargetName", "documentation": "The name of the target.
", "location": "querystring", "locationName": "targetName" } } }, "ListExperimentResolvedTargetsResponse": { "type": "structure", "members": { "resolvedTargets": { "shape": "ResolvedTargetList", "documentation": "The resolved targets.
" }, "nextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" } } }, "ListExperimentTargetAccountConfigurationsRequest": { "type": "structure", "required": [ "experimentId" ], "members": { "experimentId": { "shape": "ExperimentId", "documentation": "The ID of the experiment.
", "location": "uri", "locationName": "id" }, "nextToken": { "shape": "NextToken", "documentation": "The token for the next page of results.
", "location": "querystring", "locationName": "nextToken" } } }, "ListExperimentTargetAccountConfigurationsResponse": { "type": "structure", "members": { "targetAccountConfigurations": { "shape": "ExperimentTargetAccountConfigurationList", "documentation": "The target account configurations.
" }, "nextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" } } }, "ListExperimentTemplatesMaxResults": { "type": "integer", "max": 100, "min": 1 }, "ListExperimentTemplatesRequest": { "type": "structure", "members": { "maxResults": { "shape": "ListExperimentTemplatesMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The token for the next page of results.
", "location": "querystring", "locationName": "nextToken" } } }, "ListExperimentTemplatesResponse": { "type": "structure", "members": { "experimentTemplates": { "shape": "ExperimentTemplateSummaryList", "documentation": "The experiment templates.
" }, "nextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The token for the next page of results.
", "location": "querystring", "locationName": "nextToken" }, "experimentTemplateId": { "shape": "ExperimentTemplateId", "documentation": "The ID of the experiment template.
", "location": "querystring", "locationName": "experimentTemplateId" } } }, "ListExperimentsResponse": { "type": "structure", "members": { "experiments": { "shape": "ExperimentSummaryList", "documentation": "The experiments.
" }, "nextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The Amazon Resource Name (ARN) of the resource.
", "location": "uri", "locationName": "resourceArn" } } }, "ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "shape": "TagMap", "documentation": "The tags for the resource.
" } } }, "ListTargetAccountConfigurationsMaxResults": { "type": "integer", "box": true, "max": 100, "min": 1 }, "ListTargetAccountConfigurationsRequest": { "type": "structure", "required": [ "experimentTemplateId" ], "members": { "experimentTemplateId": { "shape": "ExperimentTemplateId", "documentation": "The ID of the experiment template.
", "location": "uri", "locationName": "id" }, "maxResults": { "shape": "ListTargetAccountConfigurationsMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
", "location": "querystring", "locationName": "maxResults" }, "nextToken": { "shape": "NextToken", "documentation": "The token for the next page of results.
", "location": "querystring", "locationName": "nextToken" } } }, "ListTargetAccountConfigurationsResponse": { "type": "structure", "members": { "targetAccountConfigurations": { "shape": "TargetAccountConfigurationList", "documentation": "The target account configurations.
" }, "nextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" } } }, "ListTargetResourceTypesMaxResults": { "type": "integer", "max": 100, "min": 1 }, "ListTargetResourceTypesRequest": { "type": "structure", "members": { "maxResults": { "shape": "ListTargetResourceTypesMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The token for the next page of results.
", "location": "querystring", "locationName": "nextToken" } } }, "ListTargetResourceTypesResponse": { "type": "structure", "members": { "targetResourceTypes": { "shape": "TargetResourceTypeSummaryList", "documentation": "The target resource types.
" }, "nextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The resource type of the target.
" }, "targetName": { "shape": "TargetName", "documentation": "The name of the target.
" }, "targetInformation": { "shape": "TargetInformationMap", "documentation": "Information about the target.
" } }, "documentation": "Describes a resolved target.
" }, "ResolvedTargetList": { "type": "list", "member": { "shape": "ResolvedTarget" } }, "ResourceArn": { "type": "string", "max": 2048, "min": 20, "pattern": "[\\S]+" }, "ResourceArnList": { "type": "list", "member": { "shape": "ResourceArn" }, "max": 5 }, "RoleArn": { "type": "string", "max": 2048, "min": 20, "pattern": "[\\S]+" }, "S3BucketName": { "type": "string", "max": 63, "min": 3, "pattern": "[\\S]+" }, "S3ObjectKey": { "type": "string", "max": 1024, "min": 1, "pattern": "[\\s\\S]+" }, "SafetyLever": { "type": "structure", "members": { "id": { "shape": "SafetyLeverId", "documentation": "The ID of the safety lever.
" }, "arn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the safety lever.
" }, "state": { "shape": "SafetyLeverState", "documentation": "The state of the safety lever.
" } }, "documentation": "Describes a safety lever.
" }, "SafetyLeverId": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "SafetyLeverState": { "type": "structure", "members": { "status": { "shape": "SafetyLeverStatus", "documentation": "The state of the safety lever.
" }, "reason": { "shape": "SafetyLeverStatusReason", "documentation": "The reason for the state of the safety lever.
" } }, "documentation": "Describes the state of the safety lever.
" }, "SafetyLeverStatus": { "type": "string", "enum": [ "disengaged", "engaged", "engaging" ] }, "SafetyLeverStatusInput": { "type": "string", "enum": [ "disengaged", "engaged" ] }, "SafetyLeverStatusReason": { "type": "string" }, "StartExperimentExperimentOptionsInput": { "type": "structure", "members": { "actionsMode": { "shape": "ActionsMode", "documentation": "Specifies the actions mode for experiment options.
" } }, "documentation": "Specifies experiment options for running an experiment.
" }, "StartExperimentRequest": { "type": "structure", "required": [ "clientToken", "experimentTemplateId" ], "members": { "clientToken": { "shape": "ClientToken", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "idempotencyToken": true }, "experimentTemplateId": { "shape": "ExperimentTemplateId", "documentation": "The ID of the experiment template.
" }, "experimentOptions": { "shape": "StartExperimentExperimentOptionsInput", "documentation": "The experiment options for running the experiment.
" }, "tags": { "shape": "TagMap", "documentation": "The tags to apply to the experiment.
" } } }, "StartExperimentResponse": { "type": "structure", "members": { "experiment": { "shape": "Experiment", "documentation": "Information about the experiment.
" } } }, "StopConditionSource": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "StopConditionValue": { "type": "string", "max": 2048, "min": 20, "pattern": "[\\s\\S]+" }, "StopExperimentRequest": { "type": "structure", "required": [ "id" ], "members": { "id": { "shape": "ExperimentId", "documentation": "The ID of the experiment.
", "location": "uri", "locationName": "id" } } }, "StopExperimentResponse": { "type": "structure", "members": { "experiment": { "shape": "Experiment", "documentation": "Information about the experiment.
" } } }, "TagKey": { "type": "string", "max": 128, "pattern": "[\\s\\S]+" }, "TagKeyList": { "type": "list", "member": { "shape": "TagKey" } }, "TagMap": { "type": "map", "key": { "shape": "TagKey" }, "value": { "shape": "TagValue" }, "max": 50 }, "TagResourceRequest": { "type": "structure", "required": [ "resourceArn", "tags" ], "members": { "resourceArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the resource.
", "location": "uri", "locationName": "resourceArn" }, "tags": { "shape": "TagMap", "documentation": "The tags for the resource.
" } } }, "TagResourceResponse": { "type": "structure", "members": {} }, "TagValue": { "type": "string", "max": 256, "pattern": "[\\s\\S]*" }, "TargetAccountConfiguration": { "type": "structure", "members": { "roleArn": { "shape": "RoleArn", "documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
" }, "accountId": { "shape": "TargetAccountId", "documentation": "The Amazon Web Services account ID of the target account.
" }, "description": { "shape": "TargetAccountConfigurationDescription", "documentation": "The description of the target account.
" } }, "documentation": "Describes a target account configuration.
" }, "TargetAccountConfigurationDescription": { "type": "string", "max": 512, "pattern": "[\\s\\S]*" }, "TargetAccountConfigurationList": { "type": "list", "member": { "shape": "TargetAccountConfigurationSummary" } }, "TargetAccountConfigurationSummary": { "type": "structure", "members": { "roleArn": { "shape": "RoleArn", "documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
" }, "accountId": { "shape": "TargetAccountId", "documentation": "The Amazon Web Services account ID of the target account.
" }, "description": { "shape": "TargetAccountConfigurationDescription", "documentation": "The description of the target account.
" } }, "documentation": "Provides a summary of a target account configuration.
" }, "TargetAccountConfigurationsCount": { "type": "long", "min": 0 }, "TargetAccountId": { "type": "string", "max": 48, "min": 12, "pattern": "[\\S]+" }, "TargetInformationKey": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "TargetInformationMap": { "type": "map", "key": { "shape": "TargetInformationKey" }, "value": { "shape": "TargetInformationValue" } }, "TargetInformationValue": { "type": "string", "max": 2048, "pattern": "[\\S]+" }, "TargetName": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "TargetResourceType": { "type": "structure", "members": { "resourceType": { "shape": "TargetResourceTypeId", "documentation": "The resource type.
" }, "description": { "shape": "TargetResourceTypeDescription", "documentation": "A description of the resource type.
" }, "parameters": { "shape": "TargetResourceTypeParameterMap", "documentation": "The parameters for the resource type.
" } }, "documentation": "Describes a resource type.
" }, "TargetResourceTypeDescription": { "type": "string", "max": 512, "pattern": "[\\s\\S]+" }, "TargetResourceTypeId": { "type": "string", "max": 128, "pattern": "[\\S]+" }, "TargetResourceTypeParameter": { "type": "structure", "members": { "description": { "shape": "TargetResourceTypeParameterDescription", "documentation": "A description of the parameter.
" }, "required": { "shape": "TargetResourceTypeParameterRequired", "documentation": "Indicates whether the parameter is required.
", "box": true } }, "documentation": "Describes the parameters for a resource type. Use parameters to determine which tasks are identified during target resolution.
" }, "TargetResourceTypeParameterDescription": { "type": "string", "max": 512, "pattern": "[\\s\\S]+" }, "TargetResourceTypeParameterMap": { "type": "map", "key": { "shape": "TargetResourceTypeParameterName" }, "value": { "shape": "TargetResourceTypeParameter" } }, "TargetResourceTypeParameterName": { "type": "string", "max": 64, "pattern": "[\\S]+" }, "TargetResourceTypeParameterRequired": { "type": "boolean" }, "TargetResourceTypeSummary": { "type": "structure", "members": { "resourceType": { "shape": "TargetResourceTypeId", "documentation": "The resource type.
" }, "description": { "shape": "TargetResourceTypeDescription", "documentation": "A description of the resource type.
" } }, "documentation": "Describes a resource type.
" }, "TargetResourceTypeSummaryList": { "type": "list", "member": { "shape": "TargetResourceTypeSummary" } }, "UntagResourceRequest": { "type": "structure", "required": [ "resourceArn" ], "members": { "resourceArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the resource.
", "location": "uri", "locationName": "resourceArn" }, "tagKeys": { "shape": "TagKeyList", "documentation": "The tag keys to remove.
", "location": "querystring", "locationName": "tagKeys" } } }, "UntagResourceResponse": { "type": "structure", "members": {} }, "UpdateExperimentTemplateActionInputItem": { "type": "structure", "members": { "actionId": { "shape": "ActionId", "documentation": "The ID of the action.
" }, "description": { "shape": "ExperimentTemplateActionDescription", "documentation": "A description for the action.
" }, "parameters": { "shape": "ExperimentTemplateActionParameterMap", "documentation": "The parameters for the action, if applicable.
" }, "targets": { "shape": "ExperimentTemplateActionTargetMap", "documentation": "The targets for the action.
" }, "startAfter": { "shape": "ExperimentTemplateActionStartAfterList", "documentation": "The name of the action that must be completed before the current action starts. Omit this parameter to run the action at the start of the experiment.
" } }, "documentation": "Specifies an action for an experiment template.
" }, "UpdateExperimentTemplateActionInputMap": { "type": "map", "key": { "shape": "ExperimentTemplateActionName" }, "value": { "shape": "UpdateExperimentTemplateActionInputItem" } }, "UpdateExperimentTemplateExperimentOptionsInput": { "type": "structure", "members": { "emptyTargetResolutionMode": { "shape": "EmptyTargetResolutionMode", "documentation": "The empty target resolution mode of the experiment template.
" } }, "documentation": "Specifies an experiment option for an experiment template.
" }, "UpdateExperimentTemplateLogConfigurationInput": { "type": "structure", "members": { "cloudWatchLogsConfiguration": { "shape": "ExperimentTemplateCloudWatchLogsLogConfigurationInput", "documentation": "The configuration for experiment logging to Amazon CloudWatch Logs.
" }, "s3Configuration": { "shape": "ExperimentTemplateS3LogConfigurationInput", "documentation": "The configuration for experiment logging to Amazon S3.
" }, "logSchemaVersion": { "shape": "LogSchemaVersion", "documentation": "The schema version.
" } }, "documentation": "Specifies the configuration for experiment logging.
" }, "UpdateExperimentTemplateRequest": { "type": "structure", "required": [ "id" ], "members": { "id": { "shape": "ExperimentTemplateId", "documentation": "The ID of the experiment template.
", "location": "uri", "locationName": "id" }, "description": { "shape": "ExperimentTemplateDescription", "documentation": "A description for the template.
" }, "stopConditions": { "shape": "UpdateExperimentTemplateStopConditionInputList", "documentation": "The stop conditions for the experiment.
" }, "targets": { "shape": "UpdateExperimentTemplateTargetInputMap", "documentation": "The targets for the experiment.
" }, "actions": { "shape": "UpdateExperimentTemplateActionInputMap", "documentation": "The actions for the experiment.
" }, "roleArn": { "shape": "RoleArn", "documentation": "The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
" }, "logConfiguration": { "shape": "UpdateExperimentTemplateLogConfigurationInput", "documentation": "The configuration for experiment logging.
" }, "experimentOptions": { "shape": "UpdateExperimentTemplateExperimentOptionsInput", "documentation": "The experiment options for the experiment template.
" } } }, "UpdateExperimentTemplateResponse": { "type": "structure", "members": { "experimentTemplate": { "shape": "ExperimentTemplate", "documentation": "Information about the experiment template.
" } } }, "UpdateExperimentTemplateStopConditionInput": { "type": "structure", "required": [ "source" ], "members": { "source": { "shape": "StopConditionSource", "documentation": "The source for the stop condition. Specify aws:cloudwatch:alarm
if the stop condition is defined by a CloudWatch alarm. Specify none
if there is no stop condition.
The Amazon Resource Name (ARN) of the CloudWatch alarm.
" } }, "documentation": "Specifies a stop condition for an experiment. You can define a stop condition as a CloudWatch alarm.
" }, "UpdateExperimentTemplateStopConditionInputList": { "type": "list", "member": { "shape": "UpdateExperimentTemplateStopConditionInput" } }, "UpdateExperimentTemplateTargetInput": { "type": "structure", "required": [ "resourceType", "selectionMode" ], "members": { "resourceType": { "shape": "TargetResourceTypeId", "documentation": "The resource type. The resource type must be supported for the specified action.
" }, "resourceArns": { "shape": "ResourceArnList", "documentation": "The Amazon Resource Names (ARNs) of the targets.
" }, "resourceTags": { "shape": "TagMap", "documentation": "The tags for the target resources.
" }, "filters": { "shape": "ExperimentTemplateTargetFilterInputList", "documentation": "The filters to apply to identify target resources using specific attributes.
" }, "selectionMode": { "shape": "ExperimentTemplateTargetSelectionMode", "documentation": "Scopes the identified resources to a specific count or percentage.
" }, "parameters": { "shape": "ExperimentTemplateTargetParameterMap", "documentation": "The resource type parameters.
" } }, "documentation": "Specifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or at least one resource tag. You cannot specify both.
" }, "UpdateExperimentTemplateTargetInputMap": { "type": "map", "key": { "shape": "ExperimentTemplateTargetName" }, "value": { "shape": "UpdateExperimentTemplateTargetInput" } }, "UpdateSafetyLeverStateInput": { "type": "structure", "required": [ "status", "reason" ], "members": { "status": { "shape": "SafetyLeverStatusInput", "documentation": "The updated state of the safety lever.
" }, "reason": { "shape": "SafetyLeverStatusReason", "documentation": "The reason for updating the state of the safety lever.
" } }, "documentation": "Specifies a state for a safety lever.
" }, "UpdateSafetyLeverStateRequest": { "type": "structure", "required": [ "id", "state" ], "members": { "id": { "shape": "SafetyLeverId", "documentation": "The ID of the safety lever.
", "location": "uri", "locationName": "id" }, "state": { "shape": "UpdateSafetyLeverStateInput", "documentation": "The state of the safety lever.
" } } }, "UpdateSafetyLeverStateResponse": { "type": "structure", "members": { "safetyLever": { "shape": "SafetyLever", "documentation": "Information about the safety lever.
" } } }, "UpdateTargetAccountConfigurationRequest": { "type": "structure", "required": [ "experimentTemplateId", "accountId" ], "members": { "experimentTemplateId": { "shape": "ExperimentTemplateId", "documentation": "The ID of the experiment template.
", "location": "uri", "locationName": "id" }, "accountId": { "shape": "TargetAccountId", "documentation": "The Amazon Web Services account ID of the target account.
", "location": "uri", "locationName": "accountId" }, "roleArn": { "shape": "RoleArn", "documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
" }, "description": { "shape": "TargetAccountConfigurationDescription", "documentation": "The description of the target account.
" } } }, "UpdateTargetAccountConfigurationResponse": { "type": "structure", "members": { "targetAccountConfiguration": { "shape": "TargetAccountConfiguration", "documentation": "Information about the target account configuration.
" } } } }, "documentation": "Amazon Web Services Fault Injection Service is a managed service that enables you to perform fault injection experiments on your Amazon Web Services workloads. For more information, see the Fault Injection Service User Guide.
" }