The AWS Fault Injection Simulator API contains several data types that various actions use. This section describes each data type in detail.
NoteThe order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• Action (p. 50)
• ActionParameter (p. 52)
• ActionSummary (p. 53)
• ActionTarget (p. 55)
• CreateExperimentTemplateActionInput (p. 56)
• CreateExperimentTemplateLogConfigurationInput (p. 58)
• CreateExperimentTemplateStopConditionInput (p. 59)
• CreateExperimentTemplateTargetInput (p. 60)
• Experiment (p. 62)
• ExperimentAction (p. 65)
• ExperimentActionState (p. 67)
• ExperimentCloudWatchLogsLogConfiguration (p. 68)
• ExperimentLogConfiguration (p. 69)
• ExperimentS3LogConfiguration (p. 70)
• ExperimentState (p. 71)
• ExperimentStopCondition (p. 72)
• ExperimentSummary (p. 73)
• ExperimentTarget (p. 75)
• ExperimentTargetFilter (p. 77)
• ExperimentTemplate (p. 78)
• ExperimentTemplateAction (p. 80)
• ExperimentTemplateCloudWatchLogsLogConfiguration (p. 82)
• ExperimentTemplateCloudWatchLogsLogConfigurationInput (p. 83)
• ExperimentTemplateLogConfiguration (p. 84)
• ExperimentTemplateS3LogConfiguration (p. 85)
• ExperimentTemplateS3LogConfigurationInput (p. 86)
• ExperimentTemplateStopCondition (p. 87)
• ExperimentTemplateSummary (p. 88)
• ExperimentTemplateTarget (p. 90)
• ExperimentTemplateTargetFilter (p. 92)
• ExperimentTemplateTargetInputFilter (p. 93)
• TargetResourceType (p. 94)
• TargetResourceTypeParameter (p. 95)
• TargetResourceTypeSummary (p. 96)
• UpdateExperimentTemplateLogConfigurationInput (p. 99)
• UpdateExperimentTemplateStopConditionInput (p. 100)
• UpdateExperimentTemplateTargetInput (p. 101)
Action
Action
Describes an action. For more information, see AWS FIS actions in the AWS Fault Injection Simulator User Guide.
Contents
description
The description for the action.
Type: String
Length Constraints: Maximum length of 512.
Pattern: [\s\S]+
Required: No id
The ID of the action.
Type: String
Length Constraints: Maximum length of 128.
Pattern: [\S]+
Required: No parameters
The action parameters, if applicable.
Type: String to ActionParameter (p. 52) object map Key Length Constraints: Maximum length of 64.
Key Pattern: [\S]+
Required: No tags
The tags for the action.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Maximum length of 128.
Key Pattern: [\s\S]+
Value Length Constraints: Maximum length of 256.
Value Pattern: [\s\S]*
Required: No targets
Type: String to ActionTarget (p. 55) object map Key Length Constraints: Maximum length of 64.
Key Pattern: [\S]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ActionParameter
ActionParameter
Describes a parameter for an action.
Contents
description
The parameter description.
Type: String
Length Constraints: Maximum length of 512.
Pattern: [\s\S]+
Required: No required
Indicates whether the parameter is required.
Type: Boolean Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ActionSummary
Provides a summary of an action.
Contents
description
The description for the action.
Type: String
Length Constraints: Maximum length of 512.
Pattern: [\s\S]+
Required: No id
The ID of the action.
Type: String
Length Constraints: Maximum length of 128.
Pattern: [\S]+
Required: No tags
The tags for the action.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Maximum length of 128.
Key Pattern: [\s\S]+
Value Length Constraints: Maximum length of 256.
Value Pattern: [\s\S]*
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ActionTarget
Describes a target for an action.
Contents
resourceType
The resource type of the target.
Type: String
Length Constraints: Maximum length of 128.
Pattern: [\S]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CreateExperimentTemplateActionInput
CreateExperimentTemplateActionInput
Specifies an action for an experiment template.
For more information, see Actions in the AWS Fault Injection Simulator User Guide.
Contents
actionId
The ID of the action. The format of the action ID is: aws:service-name:action-type.
Type: String
Length Constraints: Maximum length of 128.
Pattern: [\S]+
Required: Yes description
A description for the action.
Type: String
Length Constraints: Maximum length of 512.
Pattern: [\s\S]+
Required: No parameters
The parameters for the action, if applicable.
Type: String to string map
Key Length Constraints: Maximum length of 64.
Key Pattern: [\S]+
Value Length Constraints: Maximum length of 1024.
Value Pattern: [\S]+
Required: No startAfter
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.
Type: Array of strings
Length Constraints: Maximum length of 64.
Pattern: [\S]+
Required: No targets
Type: String to string map
Key Length Constraints: Maximum length of 64.
Key Pattern: [\S]+
Value Length Constraints: Maximum length of 64.
Value Pattern: [\S]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CreateExperimentTemplateLogConfigurationInput
CreateExperimentTemplateLogConfigurationInput
Specifies the configuration for experiment logging.
Contents
cloudWatchLogsConfiguration
The configuration for experiment logging to Amazon CloudWatch Logs.
Type: ExperimentTemplateCloudWatchLogsLogConfigurationInput (p. 83) object Required: No
logSchemaVersion The schema version.
Type: Integer Required: Yes s3Configuration
The configuration for experiment logging to Amazon S3.
Type: ExperimentTemplateS3LogConfigurationInput (p. 86) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CreateExperimentTemplateStopConditionInput
Specifies a stop condition for an experiment template.
Contents
source
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.
Type: String
Length Constraints: Maximum length of 64.
Pattern: [\S]+
Required: Yes value
The Amazon Resource Name (ARN) of the CloudWatch alarm. This is required if the source is a CloudWatch alarm.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: [\s\S]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CreateExperimentTemplateTargetInput
CreateExperimentTemplateTargetInput
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 AWS Fault Injection Simulator User Guide.
Contents
filters
The filters to apply to identify target resources using specific attributes.
Type: Array of ExperimentTemplateTargetInputFilter (p. 93) objects Required: No
parameters
The resource type parameters.
Type: String to string map
Key Length Constraints: Maximum length of 64.
Key Pattern: [\S]+
Value Length Constraints: Minimum length of 1. Maximum length of 1024.
Value Pattern: ^[\p{L}\p{Z}\p{N}_.:/=+\-@]+$
Required: No resourceArns
The Amazon Resource Names (ARNs) of the resources.
Type: Array of strings
Array Members: Maximum number of 5 items.
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: [\S]+
Required: No resourceTags
The tags for the target resources.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Maximum length of 128.
Key Pattern: [\s\S]+
Value Length Constraints: Maximum length of 256.
Required: No resourceType
The resource type. The resource type must be supported for the specified action.
Type: String
Length Constraints: Maximum length of 128.
Pattern: [\S]+
Required: Yes selectionMode
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.
Type: String
Length Constraints: Maximum length of 64.
Pattern: [\S]+
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Experiment
Experiment
Describes an experiment.
Contents
actions
The actions for the experiment.
Type: String to ExperimentAction (p. 65) object map Key Length Constraints: Maximum length of 64.
Key Pattern: [\S]+
Required: No creationTime
The time that the experiment was created.
Type: Timestamp Required: No endTime
The time that the experiment ended.
Type: Timestamp Required: No experimentTemplateId
The ID of the experiment template.
Type: String
Length Constraints: Maximum length of 64.
Pattern: [\S]+
Required: No id
The ID of the experiment.
Type: String
Length Constraints: Maximum length of 64.
Pattern: [\S]+
Required: No logConfiguration
The configuration for experiment logging.
Required: No roleArn
The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: [\S]+
Required: No startTime
The time that the experiment started.
Type: Timestamp Required: No state
The state of the experiment.
Type: ExperimentState (p. 71) object Required: No
stopConditions
The stop conditions for the experiment.
Type: Array of ExperimentStopCondition (p. 72) objects Required: No
tags
The tags for the experiment.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Maximum length of 128.
Key Pattern: [\s\S]+
Value Length Constraints: Maximum length of 256.
See Also
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ExperimentAction
Describes the action for an experiment.
Contents
actionId
The ID of the action.
Type: String
Length Constraints: Maximum length of 128.
Pattern: [\S]+
Required: No description
The description for the action.
Type: String
Length Constraints: Maximum length of 512.
Pattern: [\s\S]+
Required: No endTime
The time that the action ended.
Type: Timestamp Required: No parameters
The parameters for the action.
Type: String to string map
Key Length Constraints: Maximum length of 64.
Key Pattern: [\S]+
See Also
Required: No startTime
The time that the action started.
Type: Timestamp Required: No state
The state of the action.
Type: ExperimentActionState (p. 67) object Required: No
targets
The targets for the action.
Type: String to string map
Key Length Constraints: Maximum length of 64.
Key Pattern: [\S]+
Value Length Constraints: Maximum length of 64.
Value Pattern: [\S]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ExperimentActionState
Describes the state of an action.
Contents
reason
The reason for the state.
Type: String
Length Constraints: Maximum length of 512.
Pattern: [\s\S]+
Required: No status
The state of the action.
Type: String
Valid Values: pending | initiating | running | completed | cancelled | stopping
| stopped | failed Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ExperimentCloudWatchLogsLogConfiguration
ExperimentCloudWatchLogsLogConfiguration
Describes the configuration for experiment logging to Amazon CloudWatch Logs.
Contents
logGroupArn
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: [\S]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ExperimentLogConfiguration
Describes the configuration for experiment logging.
Contents
cloudWatchLogsConfiguration
The configuration for experiment logging to Amazon CloudWatch Logs.
Type: ExperimentCloudWatchLogsLogConfiguration (p. 68) object Required: No
logSchemaVersion The schema version.
Type: Integer Required: No s3Configuration
The configuration for experiment logging to Amazon S3.
Type: ExperimentS3LogConfiguration (p. 70) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ExperimentS3LogConfiguration
ExperimentS3LogConfiguration
Describes the configuration for experiment logging to Amazon S3.
Contents
bucketName
The name of the destination bucket.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern: [\S]+
Required: No prefix
The bucket prefix.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: [\s\S]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ExperimentState
Describes the state of an experiment.
Contents
reason
The reason for the state.
Type: String
Length Constraints: Maximum length of 512.
Pattern: [\s\S]+
Required: No status
The state of the experiment.
Type: String
Valid Values: pending | initiating | running | completed | stopping | stopped | failed
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ExperimentStopCondition
ExperimentStopCondition
Describes the stop condition for an experiment.
Contents
source
The source for the stop condition.
Type: String
Length Constraints: Maximum length of 64.
Pattern: [\S]+
Required: No value
The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: [\s\S]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ExperimentSummary
Provides a summary of an experiment.
Contents
creationTime
The time that the experiment was created.
Type: Timestamp Required: No experimentTemplateId
The ID of the experiment template.
Type: String
Length Constraints: Maximum length of 64.
Pattern: [\S]+
Required: No id
The ID of the experiment.
Type: String
Length Constraints: Maximum length of 64.
Pattern: [\S]+
Required: No state
The state of the experiment.
Type: ExperimentState (p. 71) object Required: No
tags
The tags for the experiment.
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ExperimentTarget
Describes a target for an experiment.
Contents
filters
The filters to apply to identify target resources using specific attributes.
Type: Array of ExperimentTargetFilter (p. 77) objects Required: No
parameters
The resource type parameters.
Type: String to string map
Key Length Constraints: Maximum length of 64.
Key Pattern: [\S]+
Value Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No resourceArns
The Amazon Resource Names (ARNs) of the resources.
Type: Array of strings
Array Members: Maximum number of 5 items.
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: [\S]+
Required: No resourceTags
The tags for the target resources.
Type: String to string map
See Also
Type: String
Length Constraints: Maximum length of 128.
Pattern: [\S]+
Required: No selectionMode
Scopes the identified resources to a specific count or percentage.
Type: String
Length Constraints: Maximum length of 64.
Pattern: [\S]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ExperimentTargetFilter
Describes a filter used for the target resources in an experiment.
Contents
path
The attribute path for the filter.
Type: String
Length Constraints: Maximum length of 256.
Pattern: [\S]+
Required: No values
The attribute values for the filter.
Type: Array of strings
Length Constraints: Maximum length of 128.
Pattern: [\S]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ExperimentTemplate
ExperimentTemplate
Describes an experiment template.
Contents
actions
The actions for the experiment.
Type: String to ExperimentTemplateAction (p. 80) object map Key Length Constraints: Maximum length of 64.
Key Pattern: [\S]+
Required: No creationTime
The time the experiment template was created.
Type: Timestamp Required: No description
The description for the experiment template.
Type: String
Length Constraints: Maximum length of 512.
Pattern: [\s\S]+
Required: No id
The ID of the experiment template.
Type: String
Length Constraints: Maximum length of 64.
Pattern: [\S]+
Required: No lastUpdateTime
The time the experiment template was last updated.
Type: Timestamp Required: No logConfiguration
The configuration for experiment logging.
Required: No roleArn
The Amazon Resource Name (ARN) of an IAM role.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: [\S]+
Required: No stopConditions
The stop conditions for the experiment.
Type: Array of ExperimentTemplateStopCondition (p. 87) objects Required: No
tags
The tags for the experiment template.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Maximum length of 128.
Key Pattern: [\s\S]+
Value Length Constraints: Maximum length of 256.
Value Pattern: [\s\S]*
Required: No targets
The targets for the experiment.
Type: String to ExperimentTemplateTarget (p. 90) object map Key Length Constraints: Maximum length of 64.
Key Pattern: [\S]+
Required: No
ExperimentTemplateAction
ExperimentTemplateAction
Describes an action for an experiment template.
Contents
actionId
The ID of the action.
Type: String
Length Constraints: Maximum length of 128.
Pattern: [\S]+
Required: No description
A description for the action.
Type: String
Length Constraints: Maximum length of 512.
Pattern: [\s\S]+
Required: No parameters
The parameters for the action.
Type: String to string map
Key Length Constraints: Maximum length of 64.
Key Pattern: [\S]+
Value Length Constraints: Maximum length of 1024.
Value Pattern: [\S]+
Required: No startAfter
The name of the action that must be completed before the current action starts.
Type: Array of strings
Length Constraints: Maximum length of 64.
Pattern: [\S]+
Required: No targets
The targets for the action.
Key Length Constraints: Maximum length of 64.
Key Pattern: [\S]+
Value Length Constraints: Maximum length of 64.
Value Pattern: [\S]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ExperimentTemplateCloudWatchLogsLogConfiguration
ExperimentTemplateCloudWatchLogsLogConfiguration
Describes the configuration for experiment logging to Amazon CloudWatch Logs.
Contents
logGroupArn
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: [\S]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ExperimentTemplateCloudWatchLogsLogConfigurationInput
Specifies the configuration for experiment logging to Amazon CloudWatch Logs.
Contents
logGroupArn
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: [\S]+
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ExperimentTemplateLogConfiguration
ExperimentTemplateLogConfiguration
Describes the configuration for experiment logging.
Contents
cloudWatchLogsConfiguration
The configuration for experiment logging to Amazon CloudWatch Logs.
Type: ExperimentTemplateCloudWatchLogsLogConfiguration (p. 82) object Required: No
logSchemaVersion The schema version.
Type: Integer Required: No s3Configuration
The configuration for experiment logging to Amazon S3.
Type: ExperimentTemplateS3LogConfiguration (p. 85) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ExperimentTemplateS3LogConfiguration
Describes the configuration for experiment logging to Amazon S3.
Contents
bucketName
The name of the destination bucket.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern: [\S]+
Required: No prefix
The bucket prefix.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: [\s\S]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
For more information about using this API in one of the language-specific AWS SDKs, see the following: