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 Service 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
    'experimentOptions' => [
        'accountTargeting' => 'single-account|multi-account',
        'emptyTargetResolutionMode' => 'fail|skip',
    ],
    '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

Result Syntax

[
    'experimentTemplate' => [
        'actions' => [
            '<ExperimentTemplateActionName>' => [
                'actionId' => '<string>',
                'description' => '<string>',
                'parameters' => ['<string>', ...],
                'startAfter' => ['<string>', ...],
                'targets' => ['<string>', ...],
            ],
            // ...
        ],
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'experimentOptions' => [
            'accountTargeting' => 'single-account|multi-account',
            'emptyTargetResolutionMode' => 'fail|skip',
        ],
        'id' => '<string>',
        'lastUpdateTime' => <DateTime>,
        'logConfiguration' => [
            'cloudWatchLogsConfiguration' => [
                'logGroupArn' => '<string>',
            ],
            'logSchemaVersion' => <integer>,
            's3Configuration' => [
                'bucketName' => '<string>',
                'prefix' => '<string>',
            ],
        ],
        'roleArn' => '<string>',
        'stopConditions' => [
            [
                'source' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'tags' => ['<string>', ...],
        'targetAccountConfigurationsCount' => <integer>,
        'targets' => [
            '<ExperimentTemplateTargetName>' => [
                'filters' => [
                    [
                        'path' => '<string>',
                        'values' => ['<string>', ...],
                    ],
                    // ...
                ],
                'parameters' => ['<string>', ...],
                'resourceArns' => ['<string>', ...],
                'resourceTags' => ['<string>', ...],
                'resourceType' => '<string>',
                'selectionMode' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

ConflictException:

The request could not be processed because of a conflict.

ResourceNotFoundException:

The specified resource cannot be found.

ServiceQuotaExceededException:

You have exceeded your service quota.

CreateTargetAccountConfiguration

$result = $client->createTargetAccountConfiguration([/* ... */]);
$promise = $client->createTargetAccountConfigurationAsync([/* ... */]);

Creates a target account configuration for the experiment template. A target account configuration is required when accountTargeting of experimentOptions is set to multi-account. For more information, see experiment options in the Fault Injection Service User Guide.

Parameter Syntax

$result = $client->createTargetAccountConfiguration([
    'accountId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'description' => '<string>',
    'experimentTemplateId' => '<string>', // REQUIRED
    'roleArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'targetAccountConfiguration' => [
        'accountId' => '<string>',
        'description' => '<string>',
        'roleArn' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

ConflictException:

The request could not be processed because of a conflict.

ResourceNotFoundException:

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>', ...],
            ],
            // ...
        ],
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'experimentOptions' => [
            'accountTargeting' => 'single-account|multi-account',
            'emptyTargetResolutionMode' => 'fail|skip',
        ],
        'id' => '<string>',
        'lastUpdateTime' => <DateTime>,
        'logConfiguration' => [
            'cloudWatchLogsConfiguration' => [
                'logGroupArn' => '<string>',
            ],
            'logSchemaVersion' => <integer>,
            's3Configuration' => [
                'bucketName' => '<string>',
                'prefix' => '<string>',
            ],
        ],
        'roleArn' => '<string>',
        'stopConditions' => [
            [
                'source' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'tags' => ['<string>', ...],
        'targetAccountConfigurationsCount' => <integer>,
        'targets' => [
            '<ExperimentTemplateTargetName>' => [
                'filters' => [
                    [
                        'path' => '<string>',
                        'values' => ['<string>', ...],
                    ],
                    // ...
                ],
                'parameters' => ['<string>', ...],
                'resourceArns' => ['<string>', ...],
                'resourceTags' => ['<string>', ...],
                'resourceType' => '<string>',
                'selectionMode' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException:

The specified resource cannot be found.

DeleteTargetAccountConfiguration

$result = $client->deleteTargetAccountConfiguration([/* ... */]);
$promise = $client->deleteTargetAccountConfigurationAsync([/* ... */]);

Deletes the specified target account configuration of the experiment template.

Parameter Syntax

$result = $client->deleteTargetAccountConfiguration([
    'accountId' => '<string>', // REQUIRED
    'experimentTemplateId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'targetAccountConfiguration' => [
        'accountId' => '<string>',
        'description' => '<string>',
        'roleArn' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException:

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' => [
        'arn' => '<string>',
        'description' => '<string>',
        'id' => '<string>',
        'parameters' => [
            '<ActionParameterName>' => [
                'description' => '<string>',
                'required' => true || false,
            ],
            // ...
        ],
        'tags' => ['<string>', ...],
        'targets' => [
            '<ActionTargetName>' => [
                'resourceType' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException:

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|skipped',
                ],
                'targets' => ['<string>', ...],
            ],
            // ...
        ],
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'endTime' => <DateTime>,
        'experimentOptions' => [
            'accountTargeting' => 'single-account|multi-account',
            'actionsMode' => 'skip-all|run-all',
            'emptyTargetResolutionMode' => 'fail|skip',
        ],
        '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>', ...],
        'targetAccountConfigurationsCount' => <integer>,
        'targets' => [
            '<ExperimentTargetName>' => [
                'filters' => [
                    [
                        'path' => '<string>',
                        'values' => ['<string>', ...],
                    ],
                    // ...
                ],
                'parameters' => ['<string>', ...],
                'resourceArns' => ['<string>', ...],
                'resourceTags' => ['<string>', ...],
                'resourceType' => '<string>',
                'selectionMode' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException:

The specified resource cannot be found.

GetExperimentTargetAccountConfiguration

$result = $client->getExperimentTargetAccountConfiguration([/* ... */]);
$promise = $client->getExperimentTargetAccountConfigurationAsync([/* ... */]);

Gets information about the specified target account configuration of the experiment.

Parameter Syntax

$result = $client->getExperimentTargetAccountConfiguration([
    'accountId' => '<string>', // REQUIRED
    'experimentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'targetAccountConfiguration' => [
        'accountId' => '<string>',
        'description' => '<string>',
        'roleArn' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource cannot be found.

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

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>', ...],
            ],
            // ...
        ],
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'experimentOptions' => [
            'accountTargeting' => 'single-account|multi-account',
            'emptyTargetResolutionMode' => 'fail|skip',
        ],
        'id' => '<string>',
        'lastUpdateTime' => <DateTime>,
        'logConfiguration' => [
            'cloudWatchLogsConfiguration' => [
                'logGroupArn' => '<string>',
            ],
            'logSchemaVersion' => <integer>,
            's3Configuration' => [
                'bucketName' => '<string>',
                'prefix' => '<string>',
            ],
        ],
        'roleArn' => '<string>',
        'stopConditions' => [
            [
                'source' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'tags' => ['<string>', ...],
        'targetAccountConfigurationsCount' => <integer>,
        'targets' => [
            '<ExperimentTemplateTargetName>' => [
                'filters' => [
                    [
                        'path' => '<string>',
                        'values' => ['<string>', ...],
                    ],
                    // ...
                ],
                'parameters' => ['<string>', ...],
                'resourceArns' => ['<string>', ...],
                'resourceTags' => ['<string>', ...],
                'resourceType' => '<string>',
                'selectionMode' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException:

The specified resource cannot be found.

GetTargetAccountConfiguration

$result = $client->getTargetAccountConfiguration([/* ... */]);
$promise = $client->getTargetAccountConfigurationAsync([/* ... */]);

Gets information about the specified target account configuration of the experiment template.

Parameter Syntax

$result = $client->getTargetAccountConfiguration([
    'accountId' => '<string>', // REQUIRED
    'experimentTemplateId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'targetAccountConfiguration' => [
        'accountId' => '<string>',
        'description' => '<string>',
        'roleArn' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource cannot be found.

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

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

Errors

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException:

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

Result Syntax

[
    'actions' => [
        [
            'arn' => '<string>',
            'description' => '<string>',
            'id' => '<string>',
            'tags' => ['<string>', ...],
            'targets' => [
                '<ActionTargetName>' => [
                    'resourceType' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

ListExperimentResolvedTargets

$result = $client->listExperimentResolvedTargets([/* ... */]);
$promise = $client->listExperimentResolvedTargetsAsync([/* ... */]);

Lists the resolved targets information of the specified experiment.

Parameter Syntax

$result = $client->listExperimentResolvedTargets([
    'experimentId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'targetName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'resolvedTargets' => [
        [
            'resourceType' => '<string>',
            'targetInformation' => ['<string>', ...],
            'targetName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException:

The specified resource cannot be found.

ListExperimentTargetAccountConfigurations

$result = $client->listExperimentTargetAccountConfigurations([/* ... */]);
$promise = $client->listExperimentTargetAccountConfigurationsAsync([/* ... */]);

Lists the target account configurations of the specified experiment.

Parameter Syntax

$result = $client->listExperimentTargetAccountConfigurations([
    'experimentId' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'targetAccountConfigurations' => [
        [
            'accountId' => '<string>',
            'description' => '<string>',
            'roleArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException:

The specified resource cannot be found.

ListExperimentTemplates

$result = $client->listExperimentTemplates([/* ... */]);
$promise = $client->listExperimentTemplatesAsync([/* ... */]);

Lists your experiment templates.

Parameter Syntax

$result = $client->listExperimentTemplates([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'experimentTemplates' => [
        [
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'lastUpdateTime' => <DateTime>,
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

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([
    'experimentTemplateId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'experiments' => [
        [
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'experimentOptions' => [
                'accountTargeting' => 'single-account|multi-account',
                'actionsMode' => 'skip-all|run-all',
                'emptyTargetResolutionMode' => 'fail|skip',
            ],
            'experimentTemplateId' => '<string>',
            'id' => '<string>',
            'state' => [
                'reason' => '<string>',
                'status' => 'pending|initiating|running|completed|stopping|stopped|failed',
            ],
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

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

Errors

There are no errors described for this operation.

ListTargetAccountConfigurations

$result = $client->listTargetAccountConfigurations([/* ... */]);
$promise = $client->listTargetAccountConfigurationsAsync([/* ... */]);

Lists the target account configurations of the specified experiment template.

Parameter Syntax

$result = $client->listTargetAccountConfigurations([
    'experimentTemplateId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'targetAccountConfigurations' => [
        [
            'accountId' => '<string>',
            'description' => '<string>',
            'roleArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException:

The specified resource cannot be found.

ListTargetResourceTypes

$result = $client->listTargetResourceTypes([/* ... */]);
$promise = $client->listTargetResourceTypesAsync([/* ... */]);

Lists the target resource types.

Parameter Syntax

$result = $client->listTargetResourceTypes([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'targetResourceTypes' => [
        [
            'description' => '<string>',
            'resourceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

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
    'experimentOptions' => [
        'actionsMode' => 'skip-all|run-all',
    ],
    'experimentTemplateId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

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|skipped',
                ],
                'targets' => ['<string>', ...],
            ],
            // ...
        ],
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'endTime' => <DateTime>,
        'experimentOptions' => [
            'accountTargeting' => 'single-account|multi-account',
            'actionsMode' => 'skip-all|run-all',
            'emptyTargetResolutionMode' => 'fail|skip',
        ],
        '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>', ...],
        'targetAccountConfigurationsCount' => <integer>,
        'targets' => [
            '<ExperimentTargetName>' => [
                'filters' => [
                    [
                        'path' => '<string>',
                        'values' => ['<string>', ...],
                    ],
                    // ...
                ],
                'parameters' => ['<string>', ...],
                'resourceArns' => ['<string>', ...],
                'resourceTags' => ['<string>', ...],
                'resourceType' => '<string>',
                'selectionMode' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

ConflictException:

The request could not be processed because of a conflict.

ResourceNotFoundException:

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|skipped',
                ],
                'targets' => ['<string>', ...],
            ],
            // ...
        ],
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'endTime' => <DateTime>,
        'experimentOptions' => [
            'accountTargeting' => 'single-account|multi-account',
            'actionsMode' => 'skip-all|run-all',
            'emptyTargetResolutionMode' => 'fail|skip',
        ],
        '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>', ...],
        'targetAccountConfigurationsCount' => <integer>,
        'targets' => [
            '<ExperimentTargetName>' => [
                'filters' => [
                    [
                        'path' => '<string>',
                        'values' => ['<string>', ...],
                    ],
                    // ...
                ],
                'parameters' => ['<string>', ...],
                'resourceArns' => ['<string>', ...],
                'resourceTags' => ['<string>', ...],
                'resourceType' => '<string>',
                'selectionMode' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException:

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

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

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>',
    'experimentOptions' => [
        'emptyTargetResolutionMode' => 'fail|skip',
    ],
    '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

Result Syntax

[
    'experimentTemplate' => [
        'actions' => [
            '<ExperimentTemplateActionName>' => [
                'actionId' => '<string>',
                'description' => '<string>',
                'parameters' => ['<string>', ...],
                'startAfter' => ['<string>', ...],
                'targets' => ['<string>', ...],
            ],
            // ...
        ],
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'experimentOptions' => [
            'accountTargeting' => 'single-account|multi-account',
            'emptyTargetResolutionMode' => 'fail|skip',
        ],
        'id' => '<string>',
        'lastUpdateTime' => <DateTime>,
        'logConfiguration' => [
            'cloudWatchLogsConfiguration' => [
                'logGroupArn' => '<string>',
            ],
            'logSchemaVersion' => <integer>,
            's3Configuration' => [
                'bucketName' => '<string>',
                'prefix' => '<string>',
            ],
        ],
        'roleArn' => '<string>',
        'stopConditions' => [
            [
                'source' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'tags' => ['<string>', ...],
        'targetAccountConfigurationsCount' => <integer>,
        'targets' => [
            '<ExperimentTemplateTargetName>' => [
                'filters' => [
                    [
                        'path' => '<string>',
                        'values' => ['<string>', ...],
                    ],
                    // ...
                ],
                'parameters' => ['<string>', ...],
                'resourceArns' => ['<string>', ...],
                'resourceTags' => ['<string>', ...],
                'resourceType' => '<string>',
                'selectionMode' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException:

The specified resource cannot be found.

ServiceQuotaExceededException:

You have exceeded your service quota.

UpdateTargetAccountConfiguration

$result = $client->updateTargetAccountConfiguration([/* ... */]);
$promise = $client->updateTargetAccountConfigurationAsync([/* ... */]);

Updates the target account configuration for the specified experiment template.

Parameter Syntax

$result = $client->updateTargetAccountConfiguration([
    'accountId' => '<string>', // REQUIRED
    'description' => '<string>',
    'experimentTemplateId' => '<string>', // REQUIRED
    'roleArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'targetAccountConfiguration' => [
        'accountId' => '<string>',
        'description' => '<string>',
        'roleArn' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException:

The specified resource cannot be found.