2021-03-24 00:16:10 +01:00
{
"version" : "2.0" ,
"metadata" : {
"apiVersion" : "2020-12-01" ,
"endpointPrefix" : "fis" ,
"jsonVersion" : "1.1" ,
"protocol" : "rest-json" ,
"serviceAbbreviation" : "FIS" ,
"serviceFullName" : "AWS Fault Injection Simulator" ,
"serviceId" : "fis" ,
"signatureVersion" : "v4" ,
"signingName" : "fis" ,
"uid" : "fis-2020-12-01"
} ,
"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" }
] ,
2022-05-26 00:10:07 +02:00
"documentation" : "<p>Creates an experiment template. </p> <p>An experiment template includes the following components:</p> <ul> <li> <p> <b>Targets</b>: 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.</p> </li> <li> <p> <b>Actions</b>: 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.</p> </li> <li> <p> <b>Stop conditions</b>: 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.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/fis/latest/userguide/experiment-templates.html\">Experiment templates</a> in the <i>Fault Injection Simulator User Guide</i>.</p>"
2021-03-24 00:16:10 +01:00
} ,
"DeleteExperimentTemplate" : {
"name" : "DeleteExperimentTemplate" ,
"http" : {
"method" : "DELETE" ,
"requestUri" : "/experimentTemplates/{id}" ,
"responseCode" : 200
} ,
"input" : { "shape" : "DeleteExperimentTemplateRequest" } ,
"output" : { "shape" : "DeleteExperimentTemplateResponse" } ,
"errors" : [
{ "shape" : "ValidationException" } ,
{ "shape" : "ResourceNotFoundException" }
] ,
"documentation" : "<p>Deletes the specified experiment template.</p>"
} ,
"GetAction" : {
"name" : "GetAction" ,
"http" : {
"method" : "GET" ,
"requestUri" : "/actions/{id}" ,
"responseCode" : 200
} ,
"input" : { "shape" : "GetActionRequest" } ,
"output" : { "shape" : "GetActionResponse" } ,
"errors" : [
{ "shape" : "ValidationException" } ,
{ "shape" : "ResourceNotFoundException" }
] ,
2022-05-26 00:10:07 +02:00
"documentation" : "<p>Gets information about the specified FIS action.</p>"
2021-03-24 00:16:10 +01:00
} ,
"GetExperiment" : {
"name" : "GetExperiment" ,
"http" : {
"method" : "GET" ,
"requestUri" : "/experiments/{id}" ,
"responseCode" : 200
} ,
"input" : { "shape" : "GetExperimentRequest" } ,
"output" : { "shape" : "GetExperimentResponse" } ,
"errors" : [
{ "shape" : "ValidationException" } ,
{ "shape" : "ResourceNotFoundException" }
] ,
"documentation" : "<p>Gets information about the specified experiment.</p>"
} ,
"GetExperimentTemplate" : {
"name" : "GetExperimentTemplate" ,
"http" : {
"method" : "GET" ,
"requestUri" : "/experimentTemplates/{id}" ,
"responseCode" : 200
} ,
"input" : { "shape" : "GetExperimentTemplateRequest" } ,
"output" : { "shape" : "GetExperimentTemplateResponse" } ,
"errors" : [
{ "shape" : "ValidationException" } ,
{ "shape" : "ResourceNotFoundException" }
] ,
"documentation" : "<p>Gets information about the specified experiment template.</p>"
} ,
2022-05-26 00:10:07 +02:00
"GetTargetResourceType" : {
"name" : "GetTargetResourceType" ,
"http" : {
"method" : "GET" ,
"requestUri" : "/targetResourceTypes/{resourceType}" ,
"responseCode" : 200
} ,
"input" : { "shape" : "GetTargetResourceTypeRequest" } ,
"output" : { "shape" : "GetTargetResourceTypeResponse" } ,
"errors" : [
{ "shape" : "ValidationException" } ,
{ "shape" : "ResourceNotFoundException" }
] ,
"documentation" : "<p>Gets information about the specified resource type.</p>"
} ,
2021-03-24 00:16:10 +01:00
"ListActions" : {
"name" : "ListActions" ,
"http" : {
"method" : "GET" ,
"requestUri" : "/actions" ,
"responseCode" : 200
} ,
"input" : { "shape" : "ListActionsRequest" } ,
"output" : { "shape" : "ListActionsResponse" } ,
"errors" : [
{ "shape" : "ValidationException" }
] ,
2022-05-26 00:10:07 +02:00
"documentation" : "<p>Lists the available FIS actions.</p>"
2021-03-24 00:16:10 +01:00
} ,
"ListExperimentTemplates" : {
"name" : "ListExperimentTemplates" ,
"http" : {
"method" : "GET" ,
"requestUri" : "/experimentTemplates" ,
"responseCode" : 200
} ,
"input" : { "shape" : "ListExperimentTemplatesRequest" } ,
"output" : { "shape" : "ListExperimentTemplatesResponse" } ,
"errors" : [
{ "shape" : "ValidationException" }
] ,
"documentation" : "<p>Lists your experiment templates.</p>"
} ,
"ListExperiments" : {
"name" : "ListExperiments" ,
"http" : {
"method" : "GET" ,
"requestUri" : "/experiments" ,
"responseCode" : 200
} ,
"input" : { "shape" : "ListExperimentsRequest" } ,
"output" : { "shape" : "ListExperimentsResponse" } ,
"errors" : [
{ "shape" : "ValidationException" }
] ,
"documentation" : "<p>Lists your experiments.</p>"
} ,
"ListTagsForResource" : {
"name" : "ListTagsForResource" ,
"http" : {
"method" : "GET" ,
"requestUri" : "/tags/{resourceArn}" ,
"responseCode" : 200
} ,
"input" : { "shape" : "ListTagsForResourceRequest" } ,
"output" : { "shape" : "ListTagsForResourceResponse" } ,
"documentation" : "<p>Lists the tags for the specified resource.</p>"
} ,
2022-05-26 00:10:07 +02:00
"ListTargetResourceTypes" : {
"name" : "ListTargetResourceTypes" ,
"http" : {
"method" : "GET" ,
"requestUri" : "/targetResourceTypes" ,
"responseCode" : 200
} ,
"input" : { "shape" : "ListTargetResourceTypesRequest" } ,
"output" : { "shape" : "ListTargetResourceTypesResponse" } ,
"errors" : [
{ "shape" : "ValidationException" }
] ,
"documentation" : "<p>Lists the target resource types.</p>"
} ,
2021-03-24 00:16:10 +01:00
"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" : "<p>Starts running an experiment from the specified experiment template.</p>"
} ,
"StopExperiment" : {
"name" : "StopExperiment" ,
"http" : {
"method" : "DELETE" ,
"requestUri" : "/experiments/{id}" ,
"responseCode" : 200
} ,
"input" : { "shape" : "StopExperimentRequest" } ,
"output" : { "shape" : "StopExperimentResponse" } ,
"errors" : [
{ "shape" : "ValidationException" } ,
{ "shape" : "ResourceNotFoundException" }
] ,
"documentation" : "<p>Stops the specified experiment.</p>"
} ,
"TagResource" : {
"name" : "TagResource" ,
"http" : {
"method" : "POST" ,
"requestUri" : "/tags/{resourceArn}" ,
"responseCode" : 200
} ,
"input" : { "shape" : "TagResourceRequest" } ,
"output" : { "shape" : "TagResourceResponse" } ,
"documentation" : "<p>Applies the specified tags to the specified resource.</p>"
} ,
"UntagResource" : {
"name" : "UntagResource" ,
"http" : {
"method" : "DELETE" ,
"requestUri" : "/tags/{resourceArn}" ,
"responseCode" : 200
} ,
"input" : { "shape" : "UntagResourceRequest" } ,
"output" : { "shape" : "UntagResourceResponse" } ,
"documentation" : "<p>Removes the specified tags from the specified resource.</p>"
} ,
"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" : "<p>Updates the specified experiment template.</p>"
}
} ,
"shapes" : {
"Action" : {
"type" : "structure" ,
"members" : {
"id" : {
"shape" : "ActionId" ,
"documentation" : "<p>The ID of the action.</p>"
} ,
"description" : {
"shape" : "ActionDescription" ,
"documentation" : "<p>The description for the action.</p>"
} ,
"parameters" : {
"shape" : "ActionParameterMap" ,
"documentation" : "<p>The action parameters, if applicable.</p>"
} ,
"targets" : {
"shape" : "ActionTargetMap" ,
"documentation" : "<p>The supported targets for the action.</p>"
} ,
"tags" : {
"shape" : "TagMap" ,
"documentation" : "<p>The tags for the action.</p>"
}
} ,
2022-05-26 00:10:07 +02:00
"documentation" : "<p>Describes an action. For more information, see <a href=\"https://docs.aws.amazon.com/fis/latest/userguide/fis-actions-reference.html\">FIS actions</a> in the <i>Fault Injection Simulator User Guide</i>.</p>"
2021-03-24 00:16:10 +01:00
} ,
"ActionDescription" : {
"type" : "string" ,
"max" : 512 ,
"pattern" : "[\\s\\S]+"
} ,
"ActionId" : {
"type" : "string" ,
"max" : 128 ,
"pattern" : "[\\S]+"
} ,
"ActionParameter" : {
"type" : "structure" ,
"members" : {
"description" : {
"shape" : "ActionParameterDescription" ,
"documentation" : "<p>The parameter description.</p>"
} ,
"required" : {
"shape" : "ActionParameterRequired" ,
"documentation" : "<p>Indicates whether the parameter is required.</p>" ,
"box" : true
}
} ,
"documentation" : "<p>Describes a parameter for an action.</p>"
} ,
"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" : "<p>The ID of the action.</p>"
} ,
"description" : {
"shape" : "ActionDescription" ,
"documentation" : "<p>The description for the action.</p>"
} ,
"targets" : {
"shape" : "ActionTargetMap" ,
"documentation" : "<p>The targets for the action.</p>"
} ,
"tags" : {
"shape" : "TagMap" ,
"documentation" : "<p>The tags for the action.</p>"
}
} ,
"documentation" : "<p>Provides a summary of an action.</p>"
} ,
"ActionSummaryList" : {
"type" : "list" ,
"member" : { "shape" : "ActionSummary" }
} ,
"ActionTarget" : {
"type" : "structure" ,
"members" : {
"resourceType" : {
2022-05-26 00:10:07 +02:00
"shape" : "TargetResourceTypeId" ,
2021-03-24 00:16:10 +01:00
"documentation" : "<p>The resource type of the target.</p>"
}
} ,
"documentation" : "<p>Describes a target for an action.</p>"
} ,
"ActionTargetMap" : {
"type" : "map" ,
"key" : { "shape" : "ActionTargetName" } ,
"value" : { "shape" : "ActionTarget" }
} ,
"ActionTargetName" : {
"type" : "string" ,
"max" : 64 ,
"pattern" : "[\\S]+"
} ,
"ClientToken" : {
"type" : "string" ,
"max" : 1024 ,
"min" : 1 ,
"pattern" : "[\\S]+"
} ,
2022-05-26 00:10:07 +02:00
"CloudWatchLogGroupArn" : {
"type" : "string" ,
"max" : 2048 ,
"min" : 20 ,
"pattern" : "[\\S]+"
} ,
2021-03-24 00:16:10 +01:00
"ConflictException" : {
"type" : "structure" ,
"members" : {
"message" : { "shape" : "ExceptionMessage" }
} ,
"documentation" : "<p>The request could not be processed because of a conflict.</p>" ,
"error" : { "httpStatusCode" : 409 } ,
"exception" : true
} ,
"CreateExperimentTemplateActionInput" : {
"type" : "structure" ,
"required" : [ "actionId" ] ,
"members" : {
"actionId" : {
"shape" : "ActionId" ,
2022-05-26 00:10:07 +02:00
"documentation" : "<p>The ID of the action. The format of the action ID is: aws:<i>service-name</i>:<i>action-type</i>.</p>"
2021-03-24 00:16:10 +01:00
} ,
"description" : {
"shape" : "ExperimentTemplateActionDescription" ,
"documentation" : "<p>A description for the action.</p>"
} ,
"parameters" : {
"shape" : "ExperimentTemplateActionParameterMap" ,
"documentation" : "<p>The parameters for the action, if applicable.</p>"
} ,
"targets" : {
"shape" : "ExperimentTemplateActionTargetMap" ,
"documentation" : "<p>The targets for the action.</p>"
} ,
"startAfter" : {
"shape" : "ExperimentTemplateActionStartAfterList" ,
"documentation" : "<p>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.</p>"
}
} ,
2022-05-26 00:10:07 +02:00
"documentation" : "<p>Specifies an action for an experiment template.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/fis/latest/userguide/actions.html\">Actions</a> in the <i>Fault Injection Simulator User Guide</i>.</p>"
2021-03-24 00:16:10 +01:00
} ,
"CreateExperimentTemplateActionInputMap" : {
"type" : "map" ,
"key" : { "shape" : "ExperimentTemplateActionName" } ,
"value" : { "shape" : "CreateExperimentTemplateActionInput" }
} ,
2022-05-26 00:10:07 +02:00
"CreateExperimentTemplateLogConfigurationInput" : {
"type" : "structure" ,
"required" : [ "logSchemaVersion" ] ,
"members" : {
"cloudWatchLogsConfiguration" : {
"shape" : "ExperimentTemplateCloudWatchLogsLogConfigurationInput" ,
"documentation" : "<p>The configuration for experiment logging to Amazon CloudWatch Logs.</p>"
} ,
"s3Configuration" : {
"shape" : "ExperimentTemplateS3LogConfigurationInput" ,
"documentation" : "<p>The configuration for experiment logging to Amazon S3.</p>"
} ,
"logSchemaVersion" : {
"shape" : "LogSchemaVersion" ,
"documentation" : "<p>The schema version.</p>"
}
} ,
"documentation" : "<p>Specifies the configuration for experiment logging.</p>"
} ,
2021-03-24 00:16:10 +01:00
"CreateExperimentTemplateRequest" : {
"type" : "structure" ,
"required" : [
"clientToken" ,
"description" ,
"stopConditions" ,
"actions" ,
"roleArn"
] ,
"members" : {
"clientToken" : {
"shape" : "ClientToken" ,
"documentation" : "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>" ,
"idempotencyToken" : true
} ,
"description" : {
"shape" : "ExperimentTemplateDescription" ,
2022-05-26 00:10:07 +02:00
"documentation" : "<p>A description for the experiment template.</p>"
2021-03-24 00:16:10 +01:00
} ,
"stopConditions" : {
"shape" : "CreateExperimentTemplateStopConditionInputList" ,
"documentation" : "<p>The stop conditions.</p>"
} ,
"targets" : {
"shape" : "CreateExperimentTemplateTargetInputMap" ,
"documentation" : "<p>The targets for the experiment.</p>"
} ,
"actions" : {
"shape" : "CreateExperimentTemplateActionInputMap" ,
"documentation" : "<p>The actions for the experiment.</p>"
} ,
"roleArn" : {
"shape" : "RoleArn" ,
2022-05-26 00:10:07 +02:00
"documentation" : "<p>The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.</p>"
2021-03-24 00:16:10 +01:00
} ,
"tags" : {
"shape" : "TagMap" ,
"documentation" : "<p>The tags to apply to the experiment template.</p>"
2022-05-26 00:10:07 +02:00
} ,
"logConfiguration" : {
"shape" : "CreateExperimentTemplateLogConfigurationInput" ,
"documentation" : "<p>The configuration for experiment logging.</p>"
2021-03-24 00:16:10 +01:00
}
}
} ,
"CreateExperimentTemplateResponse" : {
"type" : "structure" ,
"members" : {
"experimentTemplate" : {
"shape" : "ExperimentTemplate" ,
"documentation" : "<p>Information about the experiment template.</p>"
}
}
} ,
"CreateExperimentTemplateStopConditionInput" : {
"type" : "structure" ,
"required" : [ "source" ] ,
"members" : {
"source" : {
"shape" : "StopConditionSource" ,
"documentation" : "<p>The source for the stop condition. Specify <code>aws:cloudwatch:alarm</code> if the stop condition is defined by a CloudWatch alarm. Specify <code>none</code> if there is no stop condition.</p>"
} ,
"value" : {
"shape" : "StopConditionValue" ,
"documentation" : "<p>The Amazon Resource Name (ARN) of the CloudWatch alarm. This is required if the source is a CloudWatch alarm.</p>"
}
} ,
"documentation" : "<p>Specifies a stop condition for an experiment template.</p>"
} ,
"CreateExperimentTemplateStopConditionInputList" : {
"type" : "list" ,
"member" : { "shape" : "CreateExperimentTemplateStopConditionInput" }
} ,
"CreateExperimentTemplateTargetInput" : {
"type" : "structure" ,
"required" : [
"resourceType" ,
"selectionMode"
] ,
"members" : {
"resourceType" : {
2022-05-26 00:10:07 +02:00
"shape" : "TargetResourceTypeId" ,
"documentation" : "<p>The resource type. The resource type must be supported for the specified action.</p>"
2021-03-24 00:16:10 +01:00
} ,
"resourceArns" : {
"shape" : "ResourceArnList" ,
"documentation" : "<p>The Amazon Resource Names (ARNs) of the resources.</p>"
} ,
"resourceTags" : {
"shape" : "TagMap" ,
"documentation" : "<p>The tags for the target resources.</p>"
} ,
"filters" : {
"shape" : "ExperimentTemplateTargetFilterInputList" ,
"documentation" : "<p>The filters to apply to identify target resources using specific attributes.</p>"
} ,
"selectionMode" : {
"shape" : "ExperimentTemplateTargetSelectionMode" ,
"documentation" : "<p>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.</p> <ul> <li> <p>ALL - Run the action on all identified targets. This is the default.</p> </li> <li> <p>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.</p> </li> <li> <p>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.</p> </li> </ul>"
2022-05-26 00:10:07 +02:00
} ,
"parameters" : {
"shape" : "ExperimentTemplateTargetParameterMap" ,
"documentation" : "<p>The resource type parameters.</p>"
2021-03-24 00:16:10 +01:00
}
} ,
2022-05-26 00:10:07 +02:00
"documentation" : "<p>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.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/fis/latest/userguide/targets.html\">Targets</a> in the <i>Fault Injection Simulator User Guide</i>.</p>"
2021-03-24 00:16:10 +01:00
} ,
"CreateExperimentTemplateTargetInputMap" : {
"type" : "map" ,
"key" : { "shape" : "ExperimentTemplateTargetName" } ,
"value" : { "shape" : "CreateExperimentTemplateTargetInput" }
} ,
"CreationTime" : { "type" : "timestamp" } ,
"DeleteExperimentTemplateRequest" : {
"type" : "structure" ,
"required" : [ "id" ] ,
"members" : {
"id" : {
"shape" : "ExperimentTemplateId" ,
"documentation" : "<p>The ID of the experiment template.</p>" ,
"location" : "uri" ,
"locationName" : "id"
}
}
} ,
"DeleteExperimentTemplateResponse" : {
"type" : "structure" ,
"members" : {
"experimentTemplate" : {
"shape" : "ExperimentTemplate" ,
"documentation" : "<p>Information about the experiment template.</p>"
}
}
} ,
"ExceptionMessage" : {
"type" : "string" ,
"max" : 1024 ,
"pattern" : "[\\s\\S]+"
} ,
"Experiment" : {
"type" : "structure" ,
"members" : {
"id" : {
"shape" : "ExperimentId" ,
"documentation" : "<p>The ID of the experiment.</p>"
} ,
"experimentTemplateId" : {
"shape" : "ExperimentTemplateId" ,
"documentation" : "<p>The ID of the experiment template.</p>"
} ,
"roleArn" : {
"shape" : "RoleArn" ,
2022-05-26 00:10:07 +02:00
"documentation" : "<p>The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.</p>"
2021-03-24 00:16:10 +01:00
} ,
"state" : {
"shape" : "ExperimentState" ,
"documentation" : "<p>The state of the experiment.</p>"
} ,
"targets" : {
"shape" : "ExperimentTargetMap" ,
"documentation" : "<p>The targets for the experiment.</p>"
} ,
"actions" : {
"shape" : "ExperimentActionMap" ,
"documentation" : "<p>The actions for the experiment.</p>"
} ,
"stopConditions" : {
"shape" : "ExperimentStopConditionList" ,
"documentation" : "<p>The stop conditions for the experiment.</p>"
} ,
"creationTime" : {
"shape" : "CreationTime" ,
2022-05-26 00:10:07 +02:00
"documentation" : "<p>The time that the experiment was created.</p>"
2021-03-24 00:16:10 +01:00
} ,
"startTime" : {
"shape" : "ExperimentStartTime" ,
2022-05-26 00:10:07 +02:00
"documentation" : "<p>The time that the experiment started.</p>"
2021-03-24 00:16:10 +01:00
} ,
"endTime" : {
"shape" : "ExperimentEndTime" ,
"documentation" : "<p>The time that the experiment ended.</p>"
} ,
"tags" : {
"shape" : "TagMap" ,
"documentation" : "<p>The tags for the experiment.</p>"
2022-05-26 00:10:07 +02:00
} ,
"logConfiguration" : {
"shape" : "ExperimentLogConfiguration" ,
"documentation" : "<p>The configuration for experiment logging.</p>"
2021-03-24 00:16:10 +01:00
}
} ,
"documentation" : "<p>Describes an experiment.</p>"
} ,
"ExperimentAction" : {
"type" : "structure" ,
"members" : {
"actionId" : {
"shape" : "ActionId" ,
"documentation" : "<p>The ID of the action.</p>"
} ,
"description" : {
"shape" : "ExperimentActionDescription" ,
"documentation" : "<p>The description for the action.</p>"
} ,
"parameters" : {
"shape" : "ExperimentActionParameterMap" ,
"documentation" : "<p>The parameters for the action.</p>"
} ,
"targets" : {
"shape" : "ExperimentActionTargetMap" ,
"documentation" : "<p>The targets for the action.</p>"
} ,
"startAfter" : {
"shape" : "ExperimentActionStartAfterList" ,
"documentation" : "<p>The name of the action that must be completed before this action starts.</p>"
} ,
"state" : {
"shape" : "ExperimentActionState" ,
"documentation" : "<p>The state of the action.</p>"
2022-05-26 00:10:07 +02:00
} ,
"startTime" : {
"shape" : "ExperimentActionStartTime" ,
"documentation" : "<p>The time that the action started.</p>"
} ,
"endTime" : {
"shape" : "ExperimentActionEndTime" ,
"documentation" : "<p>The time that the action ended.</p>"
2021-03-24 00:16:10 +01:00
}
} ,
"documentation" : "<p>Describes the action for an experiment.</p>"
} ,
"ExperimentActionDescription" : {
"type" : "string" ,
"max" : 512 ,
"pattern" : "[\\s\\S]+"
} ,
2022-05-26 00:10:07 +02:00
"ExperimentActionEndTime" : { "type" : "timestamp" } ,
2021-03-24 00:16:10 +01:00
"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" }
} ,
2022-05-26 00:10:07 +02:00
"ExperimentActionStartTime" : { "type" : "timestamp" } ,
2021-03-24 00:16:10 +01:00
"ExperimentActionState" : {
"type" : "structure" ,
"members" : {
"status" : {
"shape" : "ExperimentActionStatus" ,
"documentation" : "<p>The state of the action.</p>"
} ,
"reason" : {
"shape" : "ExperimentActionStatusReason" ,
"documentation" : "<p>The reason for the state.</p>"
}
} ,
"documentation" : "<p>Describes the state of an action.</p>"
} ,
"ExperimentActionStatus" : {
"type" : "string" ,
"enum" : [
"pending" ,
"initiating" ,
"running" ,
"completed" ,
"cancelled" ,
"stopping" ,
"stopped" ,
"failed"
]
} ,
"ExperimentActionStatusReason" : {
"type" : "string" ,
"max" : 512 ,
"pattern" : "[\\s\\S]+"
} ,
"ExperimentActionTargetMap" : {
"type" : "map" ,
"key" : { "shape" : "ExperimentActionTargetName" } ,
"value" : { "shape" : "ExperimentTargetName" }
} ,
"ExperimentActionTargetName" : {
"type" : "string" ,
"max" : 64 ,
"pattern" : "[\\S]+"
} ,
2022-05-26 00:10:07 +02:00
"ExperimentCloudWatchLogsLogConfiguration" : {
"type" : "structure" ,
"members" : {
"logGroupArn" : {
"shape" : "CloudWatchLogGroupArn" ,
"documentation" : "<p>The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.</p>"
}
} ,
"documentation" : "<p>Describes the configuration for experiment logging to Amazon CloudWatch Logs.</p>"
} ,
2021-03-24 00:16:10 +01:00
"ExperimentEndTime" : { "type" : "timestamp" } ,
"ExperimentId" : {
"type" : "string" ,
"max" : 64 ,
"pattern" : "[\\S]+"
} ,
2022-05-26 00:10:07 +02:00
"ExperimentLogConfiguration" : {
"type" : "structure" ,
"members" : {
"cloudWatchLogsConfiguration" : {
"shape" : "ExperimentCloudWatchLogsLogConfiguration" ,
"documentation" : "<p>The configuration for experiment logging to Amazon CloudWatch Logs.</p>"
} ,
"s3Configuration" : {
"shape" : "ExperimentS3LogConfiguration" ,
"documentation" : "<p>The configuration for experiment logging to Amazon S3.</p>"
} ,
"logSchemaVersion" : {
"shape" : "LogSchemaVersion" ,
"documentation" : "<p>The schema version.</p>"
}
} ,
"documentation" : "<p>Describes the configuration for experiment logging.</p>"
} ,
"ExperimentS3LogConfiguration" : {
"type" : "structure" ,
"members" : {
"bucketName" : {
"shape" : "S3BucketName" ,
"documentation" : "<p>The name of the destination bucket.</p>"
} ,
"prefix" : {
"shape" : "S3ObjectKey" ,
"documentation" : "<p>The bucket prefix.</p>"
}
} ,
"documentation" : "<p>Describes the configuration for experiment logging to Amazon S3.</p>"
} ,
2021-03-24 00:16:10 +01:00
"ExperimentStartTime" : { "type" : "timestamp" } ,
"ExperimentState" : {
"type" : "structure" ,
"members" : {
"status" : {
"shape" : "ExperimentStatus" ,
"documentation" : "<p>The state of the experiment.</p>"
} ,
"reason" : {
"shape" : "ExperimentStatusReason" ,
"documentation" : "<p>The reason for the state.</p>"
}
} ,
"documentation" : "<p>Describes the state of an experiment.</p>"
} ,
"ExperimentStatus" : {
"type" : "string" ,
"enum" : [
"pending" ,
"initiating" ,
"running" ,
"completed" ,
"stopping" ,
"stopped" ,
"failed"
]
} ,
"ExperimentStatusReason" : {
"type" : "string" ,
"max" : 512 ,
"pattern" : "[\\s\\S]+"
} ,
"ExperimentStopCondition" : {
"type" : "structure" ,
"members" : {
"source" : {
"shape" : "StopConditionSource" ,
"documentation" : "<p>The source for the stop condition.</p>"
} ,
"value" : {
"shape" : "StopConditionValue" ,
"documentation" : "<p>The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.</p>"
}
} ,
"documentation" : "<p>Describes the stop condition for an experiment.</p>"
} ,
"ExperimentStopConditionList" : {
"type" : "list" ,
"member" : { "shape" : "ExperimentStopCondition" }
} ,
"ExperimentSummary" : {
"type" : "structure" ,
"members" : {
"id" : {
"shape" : "ExperimentId" ,
"documentation" : "<p>The ID of the experiment.</p>"
} ,
"experimentTemplateId" : {
"shape" : "ExperimentTemplateId" ,
"documentation" : "<p>The ID of the experiment template.</p>"
} ,
"state" : {
"shape" : "ExperimentState" ,
"documentation" : "<p>The state of the experiment.</p>"
} ,
"creationTime" : {
"shape" : "CreationTime" ,
"documentation" : "<p>The time that the experiment was created.</p>"
} ,
"tags" : {
"shape" : "TagMap" ,
"documentation" : "<p>The tags for the experiment.</p>"
}
} ,
"documentation" : "<p>Provides a summary of an experiment.</p>"
} ,
"ExperimentSummaryList" : {
"type" : "list" ,
"member" : { "shape" : "ExperimentSummary" }
} ,
"ExperimentTarget" : {
"type" : "structure" ,
"members" : {
"resourceType" : {
2022-05-26 00:10:07 +02:00
"shape" : "TargetResourceTypeId" ,
2021-03-24 00:16:10 +01:00
"documentation" : "<p>The resource type.</p>"
} ,
"resourceArns" : {
"shape" : "ResourceArnList" ,
"documentation" : "<p>The Amazon Resource Names (ARNs) of the resources.</p>"
} ,
"resourceTags" : {
"shape" : "TagMap" ,
"documentation" : "<p>The tags for the target resources.</p>"
} ,
"filters" : {
"shape" : "ExperimentTargetFilterList" ,
"documentation" : "<p>The filters to apply to identify target resources using specific attributes.</p>"
} ,
"selectionMode" : {
"shape" : "ExperimentTargetSelectionMode" ,
"documentation" : "<p>Scopes the identified resources to a specific count or percentage.</p>"
2022-05-26 00:10:07 +02:00
} ,
"parameters" : {
"shape" : "ExperimentTargetParameterMap" ,
"documentation" : "<p>The resource type parameters.</p>"
2021-03-24 00:16:10 +01:00
}
} ,
"documentation" : "<p>Describes a target for an experiment.</p>"
} ,
"ExperimentTargetFilter" : {
"type" : "structure" ,
"members" : {
"path" : {
"shape" : "ExperimentTargetFilterPath" ,
"documentation" : "<p>The attribute path for the filter.</p>"
} ,
"values" : {
"shape" : "ExperimentTargetFilterValues" ,
"documentation" : "<p>The attribute values for the filter.</p>"
}
} ,
"documentation" : "<p>Describes a filter used for the target resources in an experiment.</p>"
} ,
"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]+"
} ,
2022-05-26 00:10:07 +02:00
"ExperimentTargetParameterMap" : {
"type" : "map" ,
"key" : { "shape" : "ExperimentTargetParameterName" } ,
"value" : { "shape" : "ExperimentTargetParameterValue" }
} ,
"ExperimentTargetParameterName" : {
"type" : "string" ,
"max" : 64 ,
"pattern" : "[\\S]+"
} ,
"ExperimentTargetParameterValue" : {
"type" : "string" ,
"max" : 1024 ,
"min" : 1
} ,
2021-03-24 00:16:10 +01:00
"ExperimentTargetSelectionMode" : {
"type" : "string" ,
"max" : 64 ,
"pattern" : "[\\S]+"
} ,
"ExperimentTemplate" : {
"type" : "structure" ,
"members" : {
"id" : {
"shape" : "ExperimentTemplateId" ,
"documentation" : "<p>The ID of the experiment template.</p>"
} ,
"description" : {
"shape" : "ExperimentTemplateDescription" ,
"documentation" : "<p>The description for the experiment template.</p>"
} ,
"targets" : {
"shape" : "ExperimentTemplateTargetMap" ,
"documentation" : "<p>The targets for the experiment.</p>"
} ,
"actions" : {
"shape" : "ExperimentTemplateActionMap" ,
"documentation" : "<p>The actions for the experiment.</p>"
} ,
"stopConditions" : {
"shape" : "ExperimentTemplateStopConditionList" ,
"documentation" : "<p>The stop conditions for the experiment.</p>"
} ,
"creationTime" : {
"shape" : "CreationTime" ,
"documentation" : "<p>The time the experiment template was created.</p>"
} ,
"lastUpdateTime" : {
"shape" : "LastUpdateTime" ,
"documentation" : "<p>The time the experiment template was last updated.</p>"
} ,
"roleArn" : {
"shape" : "RoleArn" ,
"documentation" : "<p>The Amazon Resource Name (ARN) of an IAM role.</p>"
} ,
"tags" : {
"shape" : "TagMap" ,
"documentation" : "<p>The tags for the experiment template.</p>"
2022-05-26 00:10:07 +02:00
} ,
"logConfiguration" : {
"shape" : "ExperimentTemplateLogConfiguration" ,
"documentation" : "<p>The configuration for experiment logging.</p>"
2021-03-24 00:16:10 +01:00
}
} ,
"documentation" : "<p>Describes an experiment template.</p>"
} ,
"ExperimentTemplateAction" : {
"type" : "structure" ,
"members" : {
"actionId" : {
"shape" : "ActionId" ,
"documentation" : "<p>The ID of the action.</p>"
} ,
"description" : {
"shape" : "ExperimentTemplateActionDescription" ,
"documentation" : "<p>A description for the action.</p>"
} ,
"parameters" : {
"shape" : "ExperimentTemplateActionParameterMap" ,
"documentation" : "<p>The parameters for the action.</p>"
} ,
"targets" : {
"shape" : "ExperimentTemplateActionTargetMap" ,
"documentation" : "<p>The targets for the action.</p>"
} ,
"startAfter" : {
"shape" : "ExperimentTemplateActionStartAfterList" ,
"documentation" : "<p>The name of the action that must be completed before the current action starts.</p>"
}
} ,
"documentation" : "<p>Describes an action for an experiment template.</p>"
} ,
"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]+"
} ,
2022-05-26 00:10:07 +02:00
"ExperimentTemplateCloudWatchLogsLogConfiguration" : {
"type" : "structure" ,
"members" : {
"logGroupArn" : {
"shape" : "CloudWatchLogGroupArn" ,
"documentation" : "<p>The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.</p>"
}
} ,
"documentation" : "<p>Describes the configuration for experiment logging to Amazon CloudWatch Logs.</p>"
} ,
"ExperimentTemplateCloudWatchLogsLogConfigurationInput" : {
"type" : "structure" ,
"required" : [ "logGroupArn" ] ,
"members" : {
"logGroupArn" : {
"shape" : "CloudWatchLogGroupArn" ,
"documentation" : "<p>The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.</p>"
}
} ,
"documentation" : "<p>Specifies the configuration for experiment logging to Amazon CloudWatch Logs.</p>"
} ,
2021-03-24 00:16:10 +01:00
"ExperimentTemplateDescription" : {
"type" : "string" ,
"max" : 512 ,
"pattern" : "[\\s\\S]+"
} ,
"ExperimentTemplateId" : {
"type" : "string" ,
"max" : 64 ,
"pattern" : "[\\S]+"
} ,
2022-05-26 00:10:07 +02:00
"ExperimentTemplateLogConfiguration" : {
"type" : "structure" ,
"members" : {
"cloudWatchLogsConfiguration" : {
"shape" : "ExperimentTemplateCloudWatchLogsLogConfiguration" ,
"documentation" : "<p>The configuration for experiment logging to Amazon CloudWatch Logs.</p>"
} ,
"s3Configuration" : {
"shape" : "ExperimentTemplateS3LogConfiguration" ,
"documentation" : "<p>The configuration for experiment logging to Amazon S3.</p>"
} ,
"logSchemaVersion" : {
"shape" : "LogSchemaVersion" ,
"documentation" : "<p>The schema version.</p>"
}
} ,
"documentation" : "<p>Describes the configuration for experiment logging.</p>"
} ,
"ExperimentTemplateS3LogConfiguration" : {
"type" : "structure" ,
"members" : {
"bucketName" : {
"shape" : "S3BucketName" ,
"documentation" : "<p>The name of the destination bucket.</p>"
} ,
"prefix" : {
"shape" : "S3ObjectKey" ,
"documentation" : "<p>The bucket prefix.</p>"
}
} ,
"documentation" : "<p>Describes the configuration for experiment logging to Amazon S3.</p>"
} ,
"ExperimentTemplateS3LogConfigurationInput" : {
"type" : "structure" ,
"required" : [ "bucketName" ] ,
"members" : {
"bucketName" : {
"shape" : "S3BucketName" ,
"documentation" : "<p>The name of the destination bucket.</p>"
} ,
"prefix" : {
"shape" : "S3ObjectKey" ,
"documentation" : "<p>The bucket prefix.</p>"
}
} ,
"documentation" : "<p>Specifies the configuration for experiment logging to Amazon S3.</p>"
} ,
2021-03-24 00:16:10 +01:00
"ExperimentTemplateStopCondition" : {
"type" : "structure" ,
"members" : {
"source" : {
"shape" : "StopConditionSource" ,
"documentation" : "<p>The source for the stop condition.</p>"
} ,
"value" : {
"shape" : "StopConditionValue" ,
"documentation" : "<p>The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.</p>"
}
} ,
"documentation" : "<p>Describes a stop condition for an experiment template.</p>"
} ,
"ExperimentTemplateStopConditionList" : {
"type" : "list" ,
"member" : { "shape" : "ExperimentTemplateStopCondition" }
} ,
"ExperimentTemplateSummary" : {
"type" : "structure" ,
"members" : {
"id" : {
"shape" : "ExperimentTemplateId" ,
"documentation" : "<p>The ID of the experiment template.</p>"
} ,
"description" : {
"shape" : "ExperimentTemplateDescription" ,
"documentation" : "<p>The description of the experiment template.</p>"
} ,
"creationTime" : {
"shape" : "CreationTime" ,
"documentation" : "<p>The time that the experiment template was created.</p>"
} ,
"lastUpdateTime" : {
"shape" : "LastUpdateTime" ,
"documentation" : "<p>The time that the experiment template was last updated.</p>"
} ,
"tags" : {
"shape" : "TagMap" ,
"documentation" : "<p>The tags for the experiment template.</p>"
}
} ,
"documentation" : "<p>Provides a summary of an experiment template.</p>"
} ,
"ExperimentTemplateSummaryList" : {
"type" : "list" ,
"member" : { "shape" : "ExperimentTemplateSummary" }
} ,
"ExperimentTemplateTarget" : {
"type" : "structure" ,
"members" : {
"resourceType" : {
2022-05-26 00:10:07 +02:00
"shape" : "TargetResourceTypeId" ,
2021-03-24 00:16:10 +01:00
"documentation" : "<p>The resource type.</p>"
} ,
"resourceArns" : {
"shape" : "ResourceArnList" ,
"documentation" : "<p>The Amazon Resource Names (ARNs) of the targets.</p>"
} ,
"resourceTags" : {
"shape" : "TagMap" ,
"documentation" : "<p>The tags for the target resources.</p>"
} ,
"filters" : {
"shape" : "ExperimentTemplateTargetFilterList" ,
"documentation" : "<p>The filters to apply to identify target resources using specific attributes.</p>"
} ,
"selectionMode" : {
"shape" : "ExperimentTemplateTargetSelectionMode" ,
"documentation" : "<p>Scopes the identified resources to a specific count or percentage.</p>"
2022-05-26 00:10:07 +02:00
} ,
"parameters" : {
"shape" : "ExperimentTemplateTargetParameterMap" ,
"documentation" : "<p>The resource type parameters.</p>"
2021-03-24 00:16:10 +01:00
}
} ,
"documentation" : "<p>Describes a target for an experiment template.</p>"
} ,
"ExperimentTemplateTargetFilter" : {
"type" : "structure" ,
"members" : {
"path" : {
"shape" : "ExperimentTemplateTargetFilterPath" ,
"documentation" : "<p>The attribute path for the filter.</p>"
} ,
"values" : {
"shape" : "ExperimentTemplateTargetFilterValues" ,
"documentation" : "<p>The attribute values for the filter.</p>"
}
} ,
"documentation" : "<p>Describes a filter used for the target resources in an experiment template.</p>"
} ,
"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" : "<p>The attribute path for the filter.</p>"
} ,
"values" : {
"shape" : "ExperimentTemplateTargetFilterValues" ,
"documentation" : "<p>The attribute values for the filter.</p>"
}
} ,
2022-05-26 00:10:07 +02:00
"documentation" : "<p>Specifies a filter used for the target resource input in an experiment template.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/fis/latest/userguide/targets.html#target-filters\">Resource filters</a> in the <i>Fault Injection Simulator User Guide</i>.</p>"
2021-03-24 00:16:10 +01:00
} ,
"ExperimentTemplateTargetMap" : {
"type" : "map" ,
"key" : { "shape" : "ExperimentTemplateTargetName" } ,
"value" : { "shape" : "ExperimentTemplateTarget" }
} ,
"ExperimentTemplateTargetName" : {
"type" : "string" ,
"max" : 64 ,
"pattern" : "[\\S]+"
} ,
2022-05-26 00:10:07 +02:00
"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}_.:/=+\\-@]+$"
} ,
2021-03-24 00:16:10 +01:00
"ExperimentTemplateTargetSelectionMode" : {
"type" : "string" ,
"max" : 64 ,
"pattern" : "[\\S]+"
} ,
"GetActionRequest" : {
"type" : "structure" ,
"required" : [ "id" ] ,
"members" : {
"id" : {
"shape" : "ActionId" ,
"documentation" : "<p>The ID of the action.</p>" ,
"location" : "uri" ,
"locationName" : "id"
}
}
} ,
"GetActionResponse" : {
"type" : "structure" ,
"members" : {
"action" : {
"shape" : "Action" ,
"documentation" : "<p>Information about the action.</p>"
}
}
} ,
"GetExperimentRequest" : {
"type" : "structure" ,
"required" : [ "id" ] ,
"members" : {
"id" : {
"shape" : "ExperimentId" ,
"documentation" : "<p>The ID of the experiment.</p>" ,
"location" : "uri" ,
"locationName" : "id"
}
}
} ,
"GetExperimentResponse" : {
"type" : "structure" ,
"members" : {
"experiment" : {
"shape" : "Experiment" ,
"documentation" : "<p>Information about the experiment.</p>"
}
}
} ,
"GetExperimentTemplateRequest" : {
"type" : "structure" ,
"required" : [ "id" ] ,
"members" : {
"id" : {
"shape" : "ExperimentTemplateId" ,
"documentation" : "<p>The ID of the experiment template.</p>" ,
"location" : "uri" ,
"locationName" : "id"
}
}
} ,
"GetExperimentTemplateResponse" : {
"type" : "structure" ,
"members" : {
"experimentTemplate" : {
"shape" : "ExperimentTemplate" ,
"documentation" : "<p>Information about the experiment template.</p>"
}
}
} ,
2022-05-26 00:10:07 +02:00
"GetTargetResourceTypeRequest" : {
"type" : "structure" ,
"required" : [ "resourceType" ] ,
"members" : {
"resourceType" : {
"shape" : "TargetResourceTypeId" ,
"documentation" : "<p>The resource type.</p>" ,
"location" : "uri" ,
"locationName" : "resourceType"
}
}
} ,
"GetTargetResourceTypeResponse" : {
"type" : "structure" ,
"members" : {
"targetResourceType" : {
"shape" : "TargetResourceType" ,
"documentation" : "<p>Information about the resource type.</p>"
}
}
} ,
2021-03-24 00:16:10 +01:00
"LastUpdateTime" : { "type" : "timestamp" } ,
"ListActionsMaxResults" : {
"type" : "integer" ,
"max" : 100 ,
"min" : 1
} ,
"ListActionsRequest" : {
"type" : "structure" ,
"members" : {
"maxResults" : {
"shape" : "ListActionsMaxResults" ,
"documentation" : "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>" ,
"box" : true ,
"location" : "querystring" ,
"locationName" : "maxResults"
} ,
"nextToken" : {
"shape" : "NextToken" ,
"documentation" : "<p>The token for the next page of results.</p>" ,
"location" : "querystring" ,
"locationName" : "nextToken"
}
}
} ,
"ListActionsResponse" : {
"type" : "structure" ,
"members" : {
"actions" : {
"shape" : "ActionSummaryList" ,
"documentation" : "<p>The actions.</p>"
} ,
"nextToken" : {
"shape" : "NextToken" ,
"documentation" : "<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
} ,
"ListExperimentTemplatesMaxResults" : {
"type" : "integer" ,
"max" : 100 ,
"min" : 1
} ,
"ListExperimentTemplatesRequest" : {
"type" : "structure" ,
"members" : {
"maxResults" : {
"shape" : "ListExperimentTemplatesMaxResults" ,
"documentation" : "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>" ,
"box" : true ,
"location" : "querystring" ,
"locationName" : "maxResults"
} ,
"nextToken" : {
"shape" : "NextToken" ,
"documentation" : "<p>The token for the next page of results.</p>" ,
"location" : "querystring" ,
"locationName" : "nextToken"
}
}
} ,
"ListExperimentTemplatesResponse" : {
"type" : "structure" ,
"members" : {
"experimentTemplates" : {
"shape" : "ExperimentTemplateSummaryList" ,
"documentation" : "<p>The experiment templates.</p>"
} ,
"nextToken" : {
"shape" : "NextToken" ,
"documentation" : "<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
} ,
"ListExperimentsMaxResults" : {
"type" : "integer" ,
"max" : 100 ,
"min" : 1
} ,
"ListExperimentsRequest" : {
"type" : "structure" ,
"members" : {
"maxResults" : {
"shape" : "ListExperimentsMaxResults" ,
"documentation" : "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>" ,
"box" : true ,
"location" : "querystring" ,
"locationName" : "maxResults"
} ,
"nextToken" : {
"shape" : "NextToken" ,
"documentation" : "<p>The token for the next page of results.</p>" ,
"location" : "querystring" ,
"locationName" : "nextToken"
}
}
} ,
"ListExperimentsResponse" : {
"type" : "structure" ,
"members" : {
"experiments" : {
"shape" : "ExperimentSummaryList" ,
"documentation" : "<p>The experiments.</p>"
} ,
"nextToken" : {
"shape" : "NextToken" ,
"documentation" : "<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
} ,
"ListTagsForResourceRequest" : {
"type" : "structure" ,
"required" : [ "resourceArn" ] ,
"members" : {
"resourceArn" : {
"shape" : "ResourceArn" ,
"documentation" : "<p>The Amazon Resource Name (ARN) of the resource.</p>" ,
"location" : "uri" ,
"locationName" : "resourceArn"
}
}
} ,
"ListTagsForResourceResponse" : {
"type" : "structure" ,
"members" : {
"tags" : {
"shape" : "TagMap" ,
"documentation" : "<p>The tags for the resource.</p>"
}
}
} ,
2022-05-26 00:10:07 +02:00
"ListTargetResourceTypesMaxResults" : {
"type" : "integer" ,
"max" : 100 ,
"min" : 1
} ,
"ListTargetResourceTypesRequest" : {
"type" : "structure" ,
"members" : {
"maxResults" : {
"shape" : "ListTargetResourceTypesMaxResults" ,
"documentation" : "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>" ,
"box" : true ,
"location" : "querystring" ,
"locationName" : "maxResults"
} ,
"nextToken" : {
"shape" : "NextToken" ,
"documentation" : "<p>The token for the next page of results.</p>" ,
"location" : "querystring" ,
"locationName" : "nextToken"
}
}
} ,
"ListTargetResourceTypesResponse" : {
"type" : "structure" ,
"members" : {
"targetResourceTypes" : {
"shape" : "TargetResourceTypeSummaryList" ,
"documentation" : "<p>The target resource types.</p>"
} ,
"nextToken" : {
"shape" : "NextToken" ,
"documentation" : "<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
} ,
"LogSchemaVersion" : { "type" : "integer" } ,
2021-03-24 00:16:10 +01:00
"NextToken" : {
"type" : "string" ,
"max" : 1024 ,
"min" : 1 ,
"pattern" : "[\\S]+"
} ,
"ResourceArn" : {
"type" : "string" ,
"max" : 2048 ,
"min" : 20 ,
"pattern" : "[\\S]+"
} ,
"ResourceArnList" : {
"type" : "list" ,
"member" : { "shape" : "ResourceArn" } ,
"max" : 5
} ,
"ResourceNotFoundException" : {
"type" : "structure" ,
"members" : {
"message" : { "shape" : "ExceptionMessage" }
} ,
"documentation" : "<p>The specified resource cannot be found.</p>" ,
"error" : { "httpStatusCode" : 404 } ,
"exception" : true
} ,
"RoleArn" : {
"type" : "string" ,
"max" : 2048 ,
"min" : 20 ,
"pattern" : "[\\S]+"
} ,
2022-05-26 00:10:07 +02:00
"S3BucketName" : {
"type" : "string" ,
"max" : 63 ,
"min" : 3 ,
"pattern" : "[\\S]+"
} ,
"S3ObjectKey" : {
"type" : "string" ,
"max" : 1024 ,
"min" : 1 ,
"pattern" : "[\\s\\S]+"
} ,
2021-03-24 00:16:10 +01:00
"ServiceQuotaExceededException" : {
"type" : "structure" ,
"members" : {
"message" : { "shape" : "ExceptionMessage" }
} ,
"documentation" : "<p>You have exceeded your service quota.</p>" ,
"error" : { "httpStatusCode" : 402 } ,
"exception" : true
} ,
"StartExperimentRequest" : {
"type" : "structure" ,
"required" : [
"clientToken" ,
"experimentTemplateId"
] ,
"members" : {
"clientToken" : {
"shape" : "ClientToken" ,
"documentation" : "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>" ,
"idempotencyToken" : true
} ,
"experimentTemplateId" : {
"shape" : "ExperimentTemplateId" ,
"documentation" : "<p>The ID of the experiment template.</p>"
} ,
"tags" : {
"shape" : "TagMap" ,
"documentation" : "<p>The tags to apply to the experiment.</p>"
}
}
} ,
"StartExperimentResponse" : {
"type" : "structure" ,
"members" : {
"experiment" : {
"shape" : "Experiment" ,
"documentation" : "<p>Information about the experiment.</p>"
}
}
} ,
"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" : "<p>The ID of the experiment.</p>" ,
"location" : "uri" ,
"locationName" : "id"
}
}
} ,
"StopExperimentResponse" : {
"type" : "structure" ,
"members" : {
"experiment" : {
"shape" : "Experiment" ,
"documentation" : "<p>Information about the experiment.</p>"
}
}
} ,
"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" : "<p>The Amazon Resource Name (ARN) of the resource.</p>" ,
"location" : "uri" ,
"locationName" : "resourceArn"
} ,
"tags" : {
"shape" : "TagMap" ,
"documentation" : "<p>The tags for the resource.</p>"
}
}
} ,
"TagResourceResponse" : {
"type" : "structure" ,
"members" : {
}
} ,
"TagValue" : {
"type" : "string" ,
"max" : 256 ,
"pattern" : "[\\s\\S]*"
} ,
"TargetResourceType" : {
2022-05-26 00:10:07 +02:00
"type" : "structure" ,
"members" : {
"resourceType" : {
"shape" : "TargetResourceTypeId" ,
"documentation" : "<p>The resource type.</p>"
} ,
"description" : {
"shape" : "TargetResourceTypeDescription" ,
"documentation" : "<p>A description of the resource type.</p>"
} ,
"parameters" : {
"shape" : "TargetResourceTypeParameterMap" ,
"documentation" : "<p>The parameters for the resource type.</p>"
}
} ,
"documentation" : "<p>Describes a resource type.</p>"
} ,
"TargetResourceTypeDescription" : {
"type" : "string" ,
"max" : 512 ,
"pattern" : "[\\s\\S]+"
} ,
"TargetResourceTypeId" : {
2021-03-24 00:16:10 +01:00
"type" : "string" ,
"max" : 128 ,
"pattern" : "[\\S]+"
} ,
2022-05-26 00:10:07 +02:00
"TargetResourceTypeParameter" : {
"type" : "structure" ,
"members" : {
"description" : {
"shape" : "TargetResourceTypeParameterDescription" ,
"documentation" : "<p>A description of the parameter.</p>"
} ,
"required" : {
"shape" : "TargetResourceTypeParameterRequired" ,
"documentation" : "<p>Indicates whether the parameter is required.</p>" ,
"box" : true
}
} ,
"documentation" : "<p>Describes the parameters for a resource type. Use parameters to determine which tasks are identified during target resolution.</p>"
} ,
"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" : "<p>The resource type.</p>"
} ,
"description" : {
"shape" : "TargetResourceTypeDescription" ,
"documentation" : "<p>A description of the resource type.</p>"
}
} ,
"documentation" : "<p>Describes a resource type.</p>"
} ,
"TargetResourceTypeSummaryList" : {
"type" : "list" ,
"member" : { "shape" : "TargetResourceTypeSummary" }
} ,
2021-03-24 00:16:10 +01:00
"UntagResourceRequest" : {
"type" : "structure" ,
"required" : [ "resourceArn" ] ,
"members" : {
"resourceArn" : {
"shape" : "ResourceArn" ,
"documentation" : "<p>The Amazon Resource Name (ARN) of the resource.</p>" ,
"location" : "uri" ,
"locationName" : "resourceArn"
} ,
"tagKeys" : {
"shape" : "TagKeyList" ,
"documentation" : "<p>The tag keys to remove.</p>" ,
"location" : "querystring" ,
"locationName" : "tagKeys"
}
}
} ,
"UntagResourceResponse" : {
"type" : "structure" ,
"members" : {
}
} ,
"UpdateExperimentTemplateActionInputItem" : {
"type" : "structure" ,
"members" : {
"actionId" : {
"shape" : "ActionId" ,
"documentation" : "<p>The ID of the action.</p>"
} ,
"description" : {
"shape" : "ExperimentTemplateActionDescription" ,
"documentation" : "<p>A description for the action.</p>"
} ,
"parameters" : {
"shape" : "ExperimentTemplateActionParameterMap" ,
"documentation" : "<p>The parameters for the action, if applicable.</p>"
} ,
"targets" : {
"shape" : "ExperimentTemplateActionTargetMap" ,
"documentation" : "<p>The targets for the action.</p>"
} ,
"startAfter" : {
"shape" : "ExperimentTemplateActionStartAfterList" ,
"documentation" : "<p>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.</p>"
}
} ,
"documentation" : "<p>Specifies an action for an experiment template.</p>"
} ,
"UpdateExperimentTemplateActionInputMap" : {
"type" : "map" ,
"key" : { "shape" : "ExperimentTemplateActionName" } ,
"value" : { "shape" : "UpdateExperimentTemplateActionInputItem" }
} ,
2022-05-26 00:10:07 +02:00
"UpdateExperimentTemplateLogConfigurationInput" : {
"type" : "structure" ,
"members" : {
"cloudWatchLogsConfiguration" : {
"shape" : "ExperimentTemplateCloudWatchLogsLogConfigurationInput" ,
"documentation" : "<p>The configuration for experiment logging to Amazon CloudWatch Logs.</p>"
} ,
"s3Configuration" : {
"shape" : "ExperimentTemplateS3LogConfigurationInput" ,
"documentation" : "<p>The configuration for experiment logging to Amazon S3.</p>"
} ,
"logSchemaVersion" : {
"shape" : "LogSchemaVersion" ,
"documentation" : "<p>The schema version.</p>"
}
} ,
"documentation" : "<p>Specifies the configuration for experiment logging.</p>"
} ,
2021-03-24 00:16:10 +01:00
"UpdateExperimentTemplateRequest" : {
"type" : "structure" ,
"required" : [ "id" ] ,
"members" : {
"id" : {
"shape" : "ExperimentTemplateId" ,
"documentation" : "<p>The ID of the experiment template.</p>" ,
"location" : "uri" ,
"locationName" : "id"
} ,
"description" : {
"shape" : "ExperimentTemplateDescription" ,
"documentation" : "<p>A description for the template.</p>"
} ,
"stopConditions" : {
"shape" : "UpdateExperimentTemplateStopConditionInputList" ,
"documentation" : "<p>The stop conditions for the experiment.</p>"
} ,
"targets" : {
"shape" : "UpdateExperimentTemplateTargetInputMap" ,
"documentation" : "<p>The targets for the experiment.</p>"
} ,
"actions" : {
"shape" : "UpdateExperimentTemplateActionInputMap" ,
"documentation" : "<p>The actions for the experiment.</p>"
} ,
"roleArn" : {
"shape" : "RoleArn" ,
2022-05-26 00:10:07 +02:00
"documentation" : "<p>The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.</p>"
} ,
"logConfiguration" : {
"shape" : "UpdateExperimentTemplateLogConfigurationInput" ,
"documentation" : "<p>The configuration for experiment logging.</p>"
2021-03-24 00:16:10 +01:00
}
}
} ,
"UpdateExperimentTemplateResponse" : {
"type" : "structure" ,
"members" : {
"experimentTemplate" : {
"shape" : "ExperimentTemplate" ,
"documentation" : "<p>Information about the experiment template.</p>"
}
}
} ,
"UpdateExperimentTemplateStopConditionInput" : {
"type" : "structure" ,
"required" : [ "source" ] ,
"members" : {
"source" : {
"shape" : "StopConditionSource" ,
"documentation" : "<p>The source for the stop condition. Specify <code>aws:cloudwatch:alarm</code> if the stop condition is defined by a CloudWatch alarm. Specify <code>none</code> if there is no stop condition.</p>"
} ,
"value" : {
"shape" : "StopConditionValue" ,
"documentation" : "<p>The Amazon Resource Name (ARN) of the CloudWatch alarm.</p>"
}
} ,
"documentation" : "<p>Specifies a stop condition for an experiment. You can define a stop condition as a CloudWatch alarm.</p>"
} ,
"UpdateExperimentTemplateStopConditionInputList" : {
"type" : "list" ,
"member" : { "shape" : "UpdateExperimentTemplateStopConditionInput" }
} ,
"UpdateExperimentTemplateTargetInput" : {
"type" : "structure" ,
"required" : [
"resourceType" ,
"selectionMode"
] ,
"members" : {
"resourceType" : {
2022-05-26 00:10:07 +02:00
"shape" : "TargetResourceTypeId" ,
"documentation" : "<p>The resource type. The resource type must be supported for the specified action.</p>"
2021-03-24 00:16:10 +01:00
} ,
"resourceArns" : {
"shape" : "ResourceArnList" ,
"documentation" : "<p>The Amazon Resource Names (ARNs) of the targets.</p>"
} ,
"resourceTags" : {
"shape" : "TagMap" ,
"documentation" : "<p>The tags for the target resources.</p>"
} ,
"filters" : {
"shape" : "ExperimentTemplateTargetFilterInputList" ,
"documentation" : "<p>The filters to apply to identify target resources using specific attributes.</p>"
} ,
"selectionMode" : {
"shape" : "ExperimentTemplateTargetSelectionMode" ,
"documentation" : "<p>Scopes the identified resources to a specific count or percentage.</p>"
2022-05-26 00:10:07 +02:00
} ,
"parameters" : {
"shape" : "ExperimentTemplateTargetParameterMap" ,
"documentation" : "<p>The resource type parameters.</p>"
2021-03-24 00:16:10 +01:00
}
} ,
"documentation" : "<p>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.</p>"
} ,
"UpdateExperimentTemplateTargetInputMap" : {
"type" : "map" ,
"key" : { "shape" : "ExperimentTemplateTargetName" } ,
"value" : { "shape" : "UpdateExperimentTemplateTargetInput" }
} ,
"ValidationException" : {
"type" : "structure" ,
"members" : {
"message" : { "shape" : "ExceptionMessage" }
} ,
"documentation" : "<p>The specified input is not valid, or fails to satisfy the constraints for the request.</p>" ,
"error" : { "httpStatusCode" : 400 } ,
"exception" : true
}
} ,
2022-05-26 00:10:07 +02:00
"documentation" : "<p>Fault Injection Simulator is a managed service that enables you to perform fault injection experiments on your Amazon Web Services workloads. For more information, see the <a href=\"https://docs.aws.amazon.com/fis/latest/userguide/\">Fault Injection Simulator User Guide</a>.</p>"
2021-03-24 00:16:10 +01:00
}