AWS Fault Injection Simulator 2020-12-01
- Client: Aws\FIS\FISClient
- Service ID: fis
- Version: 2020-12-01
This page describes the parameters and results for the operations of the AWS Fault Injection Simulator (2020-12-01), and shows how to use the Aws\FIS\FISClient object to call the described operations. This documentation is specific to the 2020-12-01 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateExperimentTemplate ( array $params = [] )
Creates an experiment template.
- DeleteExperimentTemplate ( array $params = [] )
Deletes the specified experiment template.
- GetAction ( array $params = [] )
Gets information about the specified FIS action.
- GetExperiment ( array $params = [] )
Gets information about the specified experiment.
- GetExperimentTemplate ( array $params = [] )
Gets information about the specified experiment template.
- GetTargetResourceType ( array $params = [] )
Gets information about the specified resource type.
- ListActions ( array $params = [] )
Lists the available FIS actions.
- ListExperimentTemplates ( array $params = [] )
Lists your experiment templates.
- ListExperiments ( array $params = [] )
Lists your experiments.
- ListTagsForResource ( array $params = [] )
Lists the tags for the specified resource.
- ListTargetResourceTypes ( array $params = [] )
Lists the target resource types.
- StartExperiment ( array $params = [] )
Starts running an experiment from the specified experiment template.
- StopExperiment ( array $params = [] )
Stops the specified experiment.
- TagResource ( array $params = [] )
Applies the specified tags to the specified resource.
- UntagResource ( array $params = [] )
Removes the specified tags from the specified resource.
- UpdateExperimentTemplate ( array $params = [] )
Updates the specified experiment template.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateExperimentTemplate
$result = $client->createExperimentTemplate([/* ... */]); $promise = $client->createExperimentTemplateAsync([/* ... */]);
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 Simulator User Guide.
Parameter Syntax
$result = $client->createExperimentTemplate([
'actions' => [ // REQUIRED
'<ExperimentTemplateActionName>' => [
'actionId' => '<string>', // REQUIRED
'description' => '<string>',
'parameters' => ['<string>', ...],
'startAfter' => ['<string>', ...],
'targets' => ['<string>', ...],
],
// ...
],
'clientToken' => '<string>', // REQUIRED
'description' => '<string>', // REQUIRED
'logConfiguration' => [
'cloudWatchLogsConfiguration' => [
'logGroupArn' => '<string>', // REQUIRED
],
'logSchemaVersion' => <integer>, // REQUIRED
's3Configuration' => [
'bucketName' => '<string>', // REQUIRED
'prefix' => '<string>',
],
],
'roleArn' => '<string>', // REQUIRED
'stopConditions' => [ // REQUIRED
[
'source' => '<string>', // REQUIRED
'value' => '<string>',
],
// ...
],
'tags' => ['<string>', ...],
'targets' => [
'<ExperimentTemplateTargetName>' => [
'filters' => [
[
'path' => '<string>', // REQUIRED
'values' => ['<string>', ...], // REQUIRED
],
// ...
],
'parameters' => ['<string>', ...],
'resourceArns' => ['<string>', ...],
'resourceTags' => ['<string>', ...],
'resourceType' => '<string>', // REQUIRED
'selectionMode' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- actions
-
- Required: Yes
- Type: Associative array of custom strings keys (ExperimentTemplateActionName) to CreateExperimentTemplateActionInput structures
The actions for the experiment.
- clientToken
-
- Required: Yes
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- description
-
- Required: Yes
- Type: string
A description for the experiment template.
- logConfiguration
-
- Type: CreateExperimentTemplateLogConfigurationInput structure
The configuration for experiment logging.
- roleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
- stopConditions
-
- Required: Yes
- Type: Array of CreateExperimentTemplateStopConditionInput structures
The stop conditions.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags to apply to the experiment template.
- targets
-
- Type: Associative array of custom strings keys (ExperimentTemplateTargetName) to CreateExperimentTemplateTargetInput structures
The targets for the experiment.
Result Syntax
[
'experimentTemplate' => [
'actions' => [
'<ExperimentTemplateActionName>' => [
'actionId' => '<string>',
'description' => '<string>',
'parameters' => ['<string>', ...],
'startAfter' => ['<string>', ...],
'targets' => ['<string>', ...],
],
// ...
],
'creationTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'lastUpdateTime' => <DateTime>,
'logConfiguration' => [
'cloudWatchLogsConfiguration' => [
'logGroupArn' => '<string>',
],
'logSchemaVersion' => <integer>,
's3Configuration' => [
'bucketName' => '<string>',
'prefix' => '<string>',
],
],
'roleArn' => '<string>',
'stopConditions' => [
[
'source' => '<string>',
'value' => '<string>',
],
// ...
],
'tags' => ['<string>', ...],
'targets' => [
'<ExperimentTemplateTargetName>' => [
'filters' => [
[
'path' => '<string>',
'values' => ['<string>', ...],
],
// ...
],
'parameters' => ['<string>', ...],
'resourceArns' => ['<string>', ...],
'resourceTags' => ['<string>', ...],
'resourceType' => '<string>',
'selectionMode' => '<string>',
],
// ...
],
],
]
Result Details
Members
- experimentTemplate
-
- Type: ExperimentTemplate structure
Information about the experiment template.
Errors
-
The specified input is not valid, or fails to satisfy the constraints for the request.
-
The request could not be processed because of a conflict.
-
The specified resource cannot be found.
-
ServiceQuotaExceededException:
You have exceeded your service quota.
DeleteExperimentTemplate
$result = $client->deleteExperimentTemplate([/* ... */]); $promise = $client->deleteExperimentTemplateAsync([/* ... */]);
Deletes the specified experiment template.
Parameter Syntax
$result = $client->deleteExperimentTemplate([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'experimentTemplate' => [
'actions' => [
'<ExperimentTemplateActionName>' => [
'actionId' => '<string>',
'description' => '<string>',
'parameters' => ['<string>', ...],
'startAfter' => ['<string>', ...],
'targets' => ['<string>', ...],
],
// ...
],
'creationTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'lastUpdateTime' => <DateTime>,
'logConfiguration' => [
'cloudWatchLogsConfiguration' => [
'logGroupArn' => '<string>',
],
'logSchemaVersion' => <integer>,
's3Configuration' => [
'bucketName' => '<string>',
'prefix' => '<string>',
],
],
'roleArn' => '<string>',
'stopConditions' => [
[
'source' => '<string>',
'value' => '<string>',
],
// ...
],
'tags' => ['<string>', ...],
'targets' => [
'<ExperimentTemplateTargetName>' => [
'filters' => [
[
'path' => '<string>',
'values' => ['<string>', ...],
],
// ...
],
'parameters' => ['<string>', ...],
'resourceArns' => ['<string>', ...],
'resourceTags' => ['<string>', ...],
'resourceType' => '<string>',
'selectionMode' => '<string>',
],
// ...
],
],
]
Result Details
Members
- experimentTemplate
-
- Type: ExperimentTemplate structure
Information about the experiment template.
Errors
-
The specified input is not valid, or fails to satisfy the constraints for the request.
-
The specified resource cannot be found.
GetAction
$result = $client->getAction([/* ... */]); $promise = $client->getActionAsync([/* ... */]);
Gets information about the specified FIS action.
Parameter Syntax
$result = $client->getAction([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'action' => [
'description' => '<string>',
'id' => '<string>',
'parameters' => [
'<ActionParameterName>' => [
'description' => '<string>',
'required' => true || false,
],
// ...
],
'tags' => ['<string>', ...],
'targets' => [
'<ActionTargetName>' => [
'resourceType' => '<string>',
],
// ...
],
],
]
Result Details
Members
- action
-
- Type: Action structure
Information about the action.
Errors
-
The specified input is not valid, or fails to satisfy the constraints for the request.
-
The specified resource cannot be found.
GetExperiment
$result = $client->getExperiment([/* ... */]); $promise = $client->getExperimentAsync([/* ... */]);
Gets information about the specified experiment.
Parameter Syntax
$result = $client->getExperiment([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'experiment' => [
'actions' => [
'<ExperimentActionName>' => [
'actionId' => '<string>',
'description' => '<string>',
'endTime' => <DateTime>,
'parameters' => ['<string>', ...],
'startAfter' => ['<string>', ...],
'startTime' => <DateTime>,
'state' => [
'reason' => '<string>',
'status' => 'pending|initiating|running|completed|cancelled|stopping|stopped|failed',
],
'targets' => ['<string>', ...],
],
// ...
],
'creationTime' => <DateTime>,
'endTime' => <DateTime>,
'experimentTemplateId' => '<string>',
'id' => '<string>',
'logConfiguration' => [
'cloudWatchLogsConfiguration' => [
'logGroupArn' => '<string>',
],
'logSchemaVersion' => <integer>,
's3Configuration' => [
'bucketName' => '<string>',
'prefix' => '<string>',
],
],
'roleArn' => '<string>',
'startTime' => <DateTime>,
'state' => [
'reason' => '<string>',
'status' => 'pending|initiating|running|completed|stopping|stopped|failed',
],
'stopConditions' => [
[
'source' => '<string>',
'value' => '<string>',
],
// ...
],
'tags' => ['<string>', ...],
'targets' => [
'<ExperimentTargetName>' => [
'filters' => [
[
'path' => '<string>',
'values' => ['<string>', ...],
],
// ...
],
'parameters' => ['<string>', ...],
'resourceArns' => ['<string>', ...],
'resourceTags' => ['<string>', ...],
'resourceType' => '<string>',
'selectionMode' => '<string>',
],
// ...
],
],
]
Result Details
Members
- experiment
-
- Type: Experiment structure
Information about the experiment.
Errors
-
The specified input is not valid, or fails to satisfy the constraints for the request.
-
The specified resource cannot be found.
GetExperimentTemplate
$result = $client->getExperimentTemplate([/* ... */]); $promise = $client->getExperimentTemplateAsync([/* ... */]);
Gets information about the specified experiment template.
Parameter Syntax
$result = $client->getExperimentTemplate([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'experimentTemplate' => [
'actions' => [
'<ExperimentTemplateActionName>' => [
'actionId' => '<string>',
'description' => '<string>',
'parameters' => ['<string>', ...],
'startAfter' => ['<string>', ...],
'targets' => ['<string>', ...],
],
// ...
],
'creationTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'lastUpdateTime' => <DateTime>,
'logConfiguration' => [
'cloudWatchLogsConfiguration' => [
'logGroupArn' => '<string>',
],
'logSchemaVersion' => <integer>,
's3Configuration' => [
'bucketName' => '<string>',
'prefix' => '<string>',
],
],
'roleArn' => '<string>',
'stopConditions' => [
[
'source' => '<string>',
'value' => '<string>',
],
// ...
],
'tags' => ['<string>', ...],
'targets' => [
'<ExperimentTemplateTargetName>' => [
'filters' => [
[
'path' => '<string>',
'values' => ['<string>', ...],
],
// ...
],
'parameters' => ['<string>', ...],
'resourceArns' => ['<string>', ...],
'resourceTags' => ['<string>', ...],
'resourceType' => '<string>',
'selectionMode' => '<string>',
],
// ...
],
],
]
Result Details
Members
- experimentTemplate
-
- Type: ExperimentTemplate structure
Information about the experiment template.
Errors
-
The specified input is not valid, or fails to satisfy the constraints for the request.
-
The specified resource cannot be found.
GetTargetResourceType
$result = $client->getTargetResourceType([/* ... */]); $promise = $client->getTargetResourceTypeAsync([/* ... */]);
Gets information about the specified resource type.
Parameter Syntax
$result = $client->getTargetResourceType([
'resourceType' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'targetResourceType' => [
'description' => '<string>',
'parameters' => [
'<TargetResourceTypeParameterName>' => [
'description' => '<string>',
'required' => true || false,
],
// ...
],
'resourceType' => '<string>',
],
]
Result Details
Members
- targetResourceType
-
- Type: TargetResourceType structure
Information about the resource type.
Errors
-
The specified input is not valid, or fails to satisfy the constraints for the request.
-
The specified resource cannot be found.
ListActions
$result = $client->listActions([/* ... */]); $promise = $client->listActionsAsync([/* ... */]);
Lists the available FIS actions.
Parameter Syntax
$result = $client->listActions([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'actions' => [
[
'description' => '<string>',
'id' => '<string>',
'tags' => ['<string>', ...],
'targets' => [
'<ActionTargetName>' => [
'resourceType' => '<string>',
],
// ...
],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- actions
-
- Type: Array of ActionSummary structures
The actions.
- nextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is
nullwhen there are no more results to return.
Errors
-
The specified input is not valid, or fails to satisfy the constraints for the request.
ListExperimentTemplates
$result = $client->listExperimentTemplates([/* ... */]); $promise = $client->listExperimentTemplatesAsync([/* ... */]);
Lists your experiment templates.
Parameter Syntax
$result = $client->listExperimentTemplates([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'experimentTemplates' => [
[
'creationTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'lastUpdateTime' => <DateTime>,
'tags' => ['<string>', ...],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- experimentTemplates
-
- Type: Array of ExperimentTemplateSummary structures
The experiment templates.
- nextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is
nullwhen there are no more results to return.
Errors
-
The specified input is not valid, or fails to satisfy the constraints for the request.
ListExperiments
$result = $client->listExperiments([/* ... */]); $promise = $client->listExperimentsAsync([/* ... */]);
Lists your experiments.
Parameter Syntax
$result = $client->listExperiments([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'experiments' => [
[
'creationTime' => <DateTime>,
'experimentTemplateId' => '<string>',
'id' => '<string>',
'state' => [
'reason' => '<string>',
'status' => 'pending|initiating|running|completed|stopping|stopped|failed',
],
'tags' => ['<string>', ...],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- experiments
-
- Type: Array of ExperimentSummary structures
The experiments.
- nextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is
nullwhen there are no more results to return.
Errors
-
The specified input is not valid, or fails to satisfy the constraints for the request.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists the tags for the specified resource.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
Errors
There are no errors described for this operation.
ListTargetResourceTypes
$result = $client->listTargetResourceTypes([/* ... */]); $promise = $client->listTargetResourceTypesAsync([/* ... */]);
Lists the target resource types.
Parameter Syntax
$result = $client->listTargetResourceTypes([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'nextToken' => '<string>',
'targetResourceTypes' => [
[
'description' => '<string>',
'resourceType' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is
nullwhen there are no more results to return. - targetResourceTypes
-
- Type: Array of TargetResourceTypeSummary structures
The target resource types.
Errors
-
The specified input is not valid, or fails to satisfy the constraints for the request.
StartExperiment
$result = $client->startExperiment([/* ... */]); $promise = $client->startExperimentAsync([/* ... */]);
Starts running an experiment from the specified experiment template.
Parameter Syntax
$result = $client->startExperiment([
'clientToken' => '<string>', // REQUIRED
'experimentTemplateId' => '<string>', // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- clientToken
-
- Required: Yes
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- experimentTemplateId
-
- Required: Yes
- Type: string
The ID of the experiment template.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags to apply to the experiment.
Result Syntax
[
'experiment' => [
'actions' => [
'<ExperimentActionName>' => [
'actionId' => '<string>',
'description' => '<string>',
'endTime' => <DateTime>,
'parameters' => ['<string>', ...],
'startAfter' => ['<string>', ...],
'startTime' => <DateTime>,
'state' => [
'reason' => '<string>',
'status' => 'pending|initiating|running|completed|cancelled|stopping|stopped|failed',
],
'targets' => ['<string>', ...],
],
// ...
],
'creationTime' => <DateTime>,
'endTime' => <DateTime>,
'experimentTemplateId' => '<string>',
'id' => '<string>',
'logConfiguration' => [
'cloudWatchLogsConfiguration' => [
'logGroupArn' => '<string>',
],
'logSchemaVersion' => <integer>,
's3Configuration' => [
'bucketName' => '<string>',
'prefix' => '<string>',
],
],
'roleArn' => '<string>',
'startTime' => <DateTime>,
'state' => [
'reason' => '<string>',
'status' => 'pending|initiating|running|completed|stopping|stopped|failed',
],
'stopConditions' => [
[
'source' => '<string>',
'value' => '<string>',
],
// ...
],
'tags' => ['<string>', ...],
'targets' => [
'<ExperimentTargetName>' => [
'filters' => [
[
'path' => '<string>',
'values' => ['<string>', ...],
],
// ...
],
'parameters' => ['<string>', ...],
'resourceArns' => ['<string>', ...],
'resourceTags' => ['<string>', ...],
'resourceType' => '<string>',
'selectionMode' => '<string>',
],
// ...
],
],
]
Result Details
Members
- experiment
-
- Type: Experiment structure
Information about the experiment.
Errors
-
The specified input is not valid, or fails to satisfy the constraints for the request.
-
The request could not be processed because of a conflict.
-
The specified resource cannot be found.
-
ServiceQuotaExceededException:
You have exceeded your service quota.
StopExperiment
$result = $client->stopExperiment([/* ... */]); $promise = $client->stopExperimentAsync([/* ... */]);
Stops the specified experiment.
Parameter Syntax
$result = $client->stopExperiment([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'experiment' => [
'actions' => [
'<ExperimentActionName>' => [
'actionId' => '<string>',
'description' => '<string>',
'endTime' => <DateTime>,
'parameters' => ['<string>', ...],
'startAfter' => ['<string>', ...],
'startTime' => <DateTime>,
'state' => [
'reason' => '<string>',
'status' => 'pending|initiating|running|completed|cancelled|stopping|stopped|failed',
],
'targets' => ['<string>', ...],
],
// ...
],
'creationTime' => <DateTime>,
'endTime' => <DateTime>,
'experimentTemplateId' => '<string>',
'id' => '<string>',
'logConfiguration' => [
'cloudWatchLogsConfiguration' => [
'logGroupArn' => '<string>',
],
'logSchemaVersion' => <integer>,
's3Configuration' => [
'bucketName' => '<string>',
'prefix' => '<string>',
],
],
'roleArn' => '<string>',
'startTime' => <DateTime>,
'state' => [
'reason' => '<string>',
'status' => 'pending|initiating|running|completed|stopping|stopped|failed',
],
'stopConditions' => [
[
'source' => '<string>',
'value' => '<string>',
],
// ...
],
'tags' => ['<string>', ...],
'targets' => [
'<ExperimentTargetName>' => [
'filters' => [
[
'path' => '<string>',
'values' => ['<string>', ...],
],
// ...
],
'parameters' => ['<string>', ...],
'resourceArns' => ['<string>', ...],
'resourceTags' => ['<string>', ...],
'resourceType' => '<string>',
'selectionMode' => '<string>',
],
// ...
],
],
]
Result Details
Members
- experiment
-
- Type: Experiment structure
Information about the experiment.
Errors
-
The specified input is not valid, or fails to satisfy the constraints for the request.
-
The specified resource cannot be found.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Applies the specified tags to the specified resource.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes the specified tags from the specified resource.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...],
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
UpdateExperimentTemplate
$result = $client->updateExperimentTemplate([/* ... */]); $promise = $client->updateExperimentTemplateAsync([/* ... */]);
Updates the specified experiment template.
Parameter Syntax
$result = $client->updateExperimentTemplate([
'actions' => [
'<ExperimentTemplateActionName>' => [
'actionId' => '<string>',
'description' => '<string>',
'parameters' => ['<string>', ...],
'startAfter' => ['<string>', ...],
'targets' => ['<string>', ...],
],
// ...
],
'description' => '<string>',
'id' => '<string>', // REQUIRED
'logConfiguration' => [
'cloudWatchLogsConfiguration' => [
'logGroupArn' => '<string>', // REQUIRED
],
'logSchemaVersion' => <integer>,
's3Configuration' => [
'bucketName' => '<string>', // REQUIRED
'prefix' => '<string>',
],
],
'roleArn' => '<string>',
'stopConditions' => [
[
'source' => '<string>', // REQUIRED
'value' => '<string>',
],
// ...
],
'targets' => [
'<ExperimentTemplateTargetName>' => [
'filters' => [
[
'path' => '<string>', // REQUIRED
'values' => ['<string>', ...], // REQUIRED
],
// ...
],
'parameters' => ['<string>', ...],
'resourceArns' => ['<string>', ...],
'resourceTags' => ['<string>', ...],
'resourceType' => '<string>', // REQUIRED
'selectionMode' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- actions
-
- Type: Associative array of custom strings keys (ExperimentTemplateActionName) to UpdateExperimentTemplateActionInputItem structures
The actions for the experiment.
- description
-
- Type: string
A description for the template.
- id
-
- Required: Yes
- Type: string
The ID of the experiment template.
- logConfiguration
-
- Type: UpdateExperimentTemplateLogConfigurationInput structure
The configuration for experiment logging.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
- stopConditions
-
- Type: Array of UpdateExperimentTemplateStopConditionInput structures
The stop conditions for the experiment.
- targets
-
- Type: Associative array of custom strings keys (ExperimentTemplateTargetName) to UpdateExperimentTemplateTargetInput structures
The targets for the experiment.
Result Syntax
[
'experimentTemplate' => [
'actions' => [
'<ExperimentTemplateActionName>' => [
'actionId' => '<string>',
'description' => '<string>',
'parameters' => ['<string>', ...],
'startAfter' => ['<string>', ...],
'targets' => ['<string>', ...],
],
// ...
],
'creationTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'lastUpdateTime' => <DateTime>,
'logConfiguration' => [
'cloudWatchLogsConfiguration' => [
'logGroupArn' => '<string>',
],
'logSchemaVersion' => <integer>,
's3Configuration' => [
'bucketName' => '<string>',
'prefix' => '<string>',
],
],
'roleArn' => '<string>',
'stopConditions' => [
[
'source' => '<string>',
'value' => '<string>',
],
// ...
],
'tags' => ['<string>', ...],
'targets' => [
'<ExperimentTemplateTargetName>' => [
'filters' => [
[
'path' => '<string>',
'values' => ['<string>', ...],
],
// ...
],
'parameters' => ['<string>', ...],
'resourceArns' => ['<string>', ...],
'resourceTags' => ['<string>', ...],
'resourceType' => '<string>',
'selectionMode' => '<string>',
],
// ...
],
],
]
Result Details
Members
- experimentTemplate
-
- Type: ExperimentTemplate structure
Information about the experiment template.
Errors
-
The specified input is not valid, or fails to satisfy the constraints for the request.
-
The specified resource cannot be found.
-
ServiceQuotaExceededException:
You have exceeded your service quota.
Shapes
Action
Description
Describes an action. For more information, see FIS actions in the Fault Injection Simulator User Guide.
Members
- description
-
- Type: string
The description for the action.
- id
-
- Type: string
The ID of the action.
- parameters
-
- Type: Associative array of custom strings keys (ActionParameterName) to ActionParameter structures
The action parameters, if applicable.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags for the action.
- targets
-
- Type: Associative array of custom strings keys (ActionTargetName) to ActionTarget structures
The supported targets for the action.
ActionParameter
Description
Describes a parameter for an action.
Members
ActionSummary
Description
Provides a summary of an action.
Members
- description
-
- Type: string
The description for the action.
- id
-
- Type: string
The ID of the action.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags for the action.
- targets
-
- Type: Associative array of custom strings keys (ActionTargetName) to ActionTarget structures
The targets for the action.
ActionTarget
Description
Describes a target for an action.
Members
ConflictException
CreateExperimentTemplateActionInput
Description
Specifies an action for an experiment template.
For more information, see Actions in the Fault Injection Simulator User Guide.
Members
- actionId
-
- Required: Yes
- Type: string
The ID of the action. The format of the action ID is: aws:service-name:action-type.
- description
-
- Type: string
A description for the action.
- parameters
-
- Type: Associative array of custom strings keys (ExperimentTemplateActionParameterName) to strings
The parameters for the action, if applicable.
- startAfter
-
- Type: Array of strings
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.
- targets
-
- Type: Associative array of custom strings keys (ExperimentTemplateActionTargetName) to strings
The targets for the action.
CreateExperimentTemplateLogConfigurationInput
Description
Specifies the configuration for experiment logging.
Members
- cloudWatchLogsConfiguration
-
- Type: ExperimentTemplateCloudWatchLogsLogConfigurationInput structure
The configuration for experiment logging to Amazon CloudWatch Logs.
- logSchemaVersion
-
- Required: Yes
- Type: int
The schema version.
- s3Configuration
-
- Type: ExperimentTemplateS3LogConfigurationInput structure
The configuration for experiment logging to Amazon S3.
CreateExperimentTemplateStopConditionInput
Description
Specifies a stop condition for an experiment template.
Members
- source
-
- Required: Yes
- Type: string
The source for the stop condition. Specify
aws:cloudwatch:alarmif the stop condition is defined by a CloudWatch alarm. Specifynoneif there is no stop condition. - value
-
- Type: string
The Amazon Resource Name (ARN) of the CloudWatch alarm. This is required if the source is a CloudWatch alarm.
CreateExperimentTemplateTargetInput
Description
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 Simulator User Guide.
Members
- filters
-
- Type: Array of ExperimentTemplateTargetInputFilter structures
The filters to apply to identify target resources using specific attributes.
- parameters
-
- Type: Associative array of custom strings keys (ExperimentTemplateTargetParameterName) to strings
The resource type parameters.
- resourceArns
-
- Type: Array of strings
The Amazon Resource Names (ARNs) of the resources.
- resourceTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags for the target resources.
- resourceType
-
- Required: Yes
- Type: string
The resource type. The resource type must be supported for the specified action.
- selectionMode
-
- Required: Yes
- Type: string
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.
Experiment
Description
Describes an experiment.
Members
- actions
-
- Type: Associative array of custom strings keys (ExperimentActionName) to ExperimentAction structures
The actions for the experiment.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the experiment was created.
- endTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the experiment ended.
- experimentTemplateId
-
- Type: string
The ID of the experiment template.
- id
-
- Type: string
The ID of the experiment.
- logConfiguration
-
- Type: ExperimentLogConfiguration structure
The configuration for experiment logging.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
- startTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the experiment started.
- state
-
- Type: ExperimentState structure
The state of the experiment.
- stopConditions
-
- Type: Array of ExperimentStopCondition structures
The stop conditions for the experiment.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags for the experiment.
- targets
-
- Type: Associative array of custom strings keys (ExperimentTargetName) to ExperimentTarget structures
The targets for the experiment.
ExperimentAction
Description
Describes the action for an experiment.
Members
- actionId
-
- Type: string
The ID of the action.
- description
-
- Type: string
The description for the action.
- endTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the action ended.
- parameters
-
- Type: Associative array of custom strings keys (ExperimentActionParameterName) to strings
The parameters for the action.
- startAfter
-
- Type: Array of strings
The name of the action that must be completed before this action starts.
- startTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the action started.
- state
-
- Type: ExperimentActionState structure
The state of the action.
- targets
-
- Type: Associative array of custom strings keys (ExperimentActionTargetName) to strings
The targets for the action.
ExperimentActionState
Description
Describes the state of an action.
Members
ExperimentCloudWatchLogsLogConfiguration
Description
Describes the configuration for experiment logging to Amazon CloudWatch Logs.
Members
ExperimentLogConfiguration
Description
Describes the configuration for experiment logging.
Members
- cloudWatchLogsConfiguration
-
- Type: ExperimentCloudWatchLogsLogConfiguration structure
The configuration for experiment logging to Amazon CloudWatch Logs.
- logSchemaVersion
-
- Type: int
The schema version.
- s3Configuration
-
- Type: ExperimentS3LogConfiguration structure
The configuration for experiment logging to Amazon S3.
ExperimentS3LogConfiguration
Description
Describes the configuration for experiment logging to Amazon S3.
Members
ExperimentState
Description
Describes the state of an experiment.
Members
ExperimentStopCondition
Description
Describes the stop condition for an experiment.
Members
ExperimentSummary
Description
Provides a summary of an experiment.
Members
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the experiment was created.
- experimentTemplateId
-
- Type: string
The ID of the experiment template.
- id
-
- Type: string
The ID of the experiment.
- state
-
- Type: ExperimentState structure
The state of the experiment.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags for the experiment.
ExperimentTarget
Description
Describes a target for an experiment.
Members
- filters
-
- Type: Array of ExperimentTargetFilter structures
The filters to apply to identify target resources using specific attributes.
- parameters
-
- Type: Associative array of custom strings keys (ExperimentTargetParameterName) to strings
The resource type parameters.
- resourceArns
-
- Type: Array of strings
The Amazon Resource Names (ARNs) of the resources.
- resourceTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags for the target resources.
- resourceType
-
- Type: string
The resource type.
- selectionMode
-
- Type: string
Scopes the identified resources to a specific count or percentage.
ExperimentTargetFilter
Description
Describes a filter used for the target resources in an experiment.
Members
ExperimentTemplate
Description
Describes an experiment template.
Members
- actions
-
- Type: Associative array of custom strings keys (ExperimentTemplateActionName) to ExperimentTemplateAction structures
The actions for the experiment.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the experiment template was created.
- description
-
- Type: string
The description for the experiment template.
- id
-
- Type: string
The ID of the experiment template.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the experiment template was last updated.
- logConfiguration
-
- Type: ExperimentTemplateLogConfiguration structure
The configuration for experiment logging.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of an IAM role.
- stopConditions
-
- Type: Array of ExperimentTemplateStopCondition structures
The stop conditions for the experiment.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags for the experiment template.
- targets
-
- Type: Associative array of custom strings keys (ExperimentTemplateTargetName) to ExperimentTemplateTarget structures
The targets for the experiment.
ExperimentTemplateAction
Description
Describes an action for an experiment template.
Members
- actionId
-
- Type: string
The ID of the action.
- description
-
- Type: string
A description for the action.
- parameters
-
- Type: Associative array of custom strings keys (ExperimentTemplateActionParameterName) to strings
The parameters for the action.
- startAfter
-
- Type: Array of strings
The name of the action that must be completed before the current action starts.
- targets
-
- Type: Associative array of custom strings keys (ExperimentTemplateActionTargetName) to strings
The targets for the action.
ExperimentTemplateCloudWatchLogsLogConfiguration
Description
Describes the configuration for experiment logging to Amazon CloudWatch Logs.
Members
ExperimentTemplateCloudWatchLogsLogConfigurationInput
Description
Specifies the configuration for experiment logging to Amazon CloudWatch Logs.
Members
ExperimentTemplateLogConfiguration
Description
Describes the configuration for experiment logging.
Members
- cloudWatchLogsConfiguration
-
- Type: ExperimentTemplateCloudWatchLogsLogConfiguration structure
The configuration for experiment logging to Amazon CloudWatch Logs.
- logSchemaVersion
-
- Type: int
The schema version.
- s3Configuration
-
- Type: ExperimentTemplateS3LogConfiguration structure
The configuration for experiment logging to Amazon S3.
ExperimentTemplateS3LogConfiguration
Description
Describes the configuration for experiment logging to Amazon S3.
Members
ExperimentTemplateS3LogConfigurationInput
Description
Specifies the configuration for experiment logging to Amazon S3.
Members
ExperimentTemplateStopCondition
Description
Describes a stop condition for an experiment template.
Members
ExperimentTemplateSummary
Description
Provides a summary of an experiment template.
Members
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the experiment template was created.
- description
-
- Type: string
The description of the experiment template.
- id
-
- Type: string
The ID of the experiment template.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the experiment template was last updated.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags for the experiment template.
ExperimentTemplateTarget
Description
Describes a target for an experiment template.
Members
- filters
-
- Type: Array of ExperimentTemplateTargetFilter structures
The filters to apply to identify target resources using specific attributes.
- parameters
-
- Type: Associative array of custom strings keys (ExperimentTemplateTargetParameterName) to strings
The resource type parameters.
- resourceArns
-
- Type: Array of strings
The Amazon Resource Names (ARNs) of the targets.
- resourceTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags for the target resources.
- resourceType
-
- Type: string
The resource type.
- selectionMode
-
- Type: string
Scopes the identified resources to a specific count or percentage.
ExperimentTemplateTargetFilter
Description
Describes a filter used for the target resources in an experiment template.
Members
ExperimentTemplateTargetInputFilter
Description
Specifies a filter used for the target resource input in an experiment template.
For more information, see Resource filters in the Fault Injection Simulator User Guide.
Members
ResourceNotFoundException
ServiceQuotaExceededException
TargetResourceType
Description
Describes a resource type.
Members
- description
-
- Type: string
A description of the resource type.
- parameters
-
- Type: Associative array of custom strings keys (TargetResourceTypeParameterName) to TargetResourceTypeParameter structures
The parameters for the resource type.
- resourceType
-
- Type: string
The resource type.
TargetResourceTypeParameter
Description
Describes the parameters for a resource type. Use parameters to determine which tasks are identified during target resolution.
Members
TargetResourceTypeSummary
Description
Describes a resource type.
Members
UpdateExperimentTemplateActionInputItem
Description
Specifies an action for an experiment template.
Members
- actionId
-
- Type: string
The ID of the action.
- description
-
- Type: string
A description for the action.
- parameters
-
- Type: Associative array of custom strings keys (ExperimentTemplateActionParameterName) to strings
The parameters for the action, if applicable.
- startAfter
-
- Type: Array of strings
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.
- targets
-
- Type: Associative array of custom strings keys (ExperimentTemplateActionTargetName) to strings
The targets for the action.
UpdateExperimentTemplateLogConfigurationInput
Description
Specifies the configuration for experiment logging.
Members
- cloudWatchLogsConfiguration
-
- Type: ExperimentTemplateCloudWatchLogsLogConfigurationInput structure
The configuration for experiment logging to Amazon CloudWatch Logs.
- logSchemaVersion
-
- Type: int
The schema version.
- s3Configuration
-
- Type: ExperimentTemplateS3LogConfigurationInput structure
The configuration for experiment logging to Amazon S3.
UpdateExperimentTemplateStopConditionInput
Description
Specifies a stop condition for an experiment. You can define a stop condition as a CloudWatch alarm.
Members
UpdateExperimentTemplateTargetInput
Description
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.
Members
- filters
-
- Type: Array of ExperimentTemplateTargetInputFilter structures
The filters to apply to identify target resources using specific attributes.
- parameters
-
- Type: Associative array of custom strings keys (ExperimentTemplateTargetParameterName) to strings
The resource type parameters.
- resourceArns
-
- Type: Array of strings
The Amazon Resource Names (ARNs) of the targets.
- resourceTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags for the target resources.
- resourceType
-
- Required: Yes
- Type: string
The resource type. The resource type must be supported for the specified action.
- selectionMode
-
- Required: Yes
- Type: string
Scopes the identified resources to a specific count or percentage.