[ aws . fis ]

get-experiment

Description

Gets information about the specified experiment.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-experiment
--id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--id (string)

The ID of the experiment.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To get experiment details

The following get-experiment example gets the details of the specified experiment.

aws fis get-experiment \
    --id ABC12DeFGhI3jKLMNOP

Output:

{
    "experiment": {
        "id": "ABC12DeFGhI3jKLMNOP",
        "experimentTemplateId": "ABCDE1fgHIJkLmNop",
        "roleArn": "arn:aws:iam::123456789012:role/myRole",
        "state": {
            "status": "completed",
            "reason": "Experiment completed."
        },
        "targets": {
            "Instances-Target-1": {
                "resourceType": "aws:ec2:instance",
                "resourceArns": [
                    "arn:aws:ec2:us-west-2:123456789012:instance/i-12a3b4c56d78e9012"
                ],
                "selectionMode": "ALL"
            }
        },
        "actions": {
            "reboot": {
                "actionId": "aws:ec2:reboot-instances",
                "parameters": {},
                "targets": {
                    "Instances": "Instances-Target-1"
                },
                "state": {
                    "status": "completed",
                    "reason": "Action was completed."
                }
            }
        },
        "stopConditions": [
            {
                "source": "none"
            }
        ],
        "creationTime": 1616432509.662,
        "startTime": 1616432509.962,
        "endTime": 1616432522.307,
        "tags": {}
    }
}

For more information, see Experiments for AWS FIS in the AWS Fault Injection Simulator User Guide.

Output

experiment -> (structure)

Information about the experiment.

id -> (string)

The ID of the experiment.

experimentTemplateId -> (string)

The ID of the experiment template.

roleArn -> (string)

The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.

state -> (structure)

The state of the experiment.

status -> (string)

The state of the experiment.

reason -> (string)

The reason for the state.

targets -> (map)

The targets for the experiment.

key -> (string)

value -> (structure)

Describes a target for an experiment.

resourceType -> (string)

The resource type.

resourceArns -> (list)

The Amazon Resource Names (ARNs) of the resources.

(string)

resourceTags -> (map)

The tags for the target resources.

key -> (string)

value -> (string)

filters -> (list)

The filters to apply to identify target resources using specific attributes.

(structure)

Describes a filter used for the target resources in an experiment.

path -> (string)

The attribute path for the filter.

values -> (list)

The attribute values for the filter.

(string)

selectionMode -> (string)

Scopes the identified resources to a specific count or percentage.

parameters -> (map)

The resource type parameters.

key -> (string)

value -> (string)

actions -> (map)

The actions for the experiment.

key -> (string)

value -> (structure)

Describes the action for an experiment.

actionId -> (string)

The ID of the action.

description -> (string)

The description for the action.

parameters -> (map)

The parameters for the action.

key -> (string)

value -> (string)

targets -> (map)

The targets for the action.

key -> (string)

value -> (string)

startAfter -> (list)

The name of the action that must be completed before this action starts.

(string)

state -> (structure)

The state of the action.

status -> (string)

The state of the action.

reason -> (string)

The reason for the state.

startTime -> (timestamp)

The time that the action started.

endTime -> (timestamp)

The time that the action ended.

stopConditions -> (list)

The stop conditions for the experiment.

(structure)

Describes the stop condition for an experiment.

source -> (string)

The source for the stop condition.

value -> (string)

The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.

creationTime -> (timestamp)

The time that the experiment was created.

startTime -> (timestamp)

The time that the experiment started.

endTime -> (timestamp)

The time that the experiment ended.

tags -> (map)

The tags for the experiment.

key -> (string)

value -> (string)