Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . fis ]

get-experiment-template

Description

Gets information about the specified experiment template.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--id (string)

The ID of the experiment template.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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 template details

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

aws fis get-experiment-template \
    --id ABCDE1fgHIJkLmNop

Output:

{
    "experimentTemplate": {
        "id": "ABCDE1fgHIJkLmNop",
        "description": "myExperimentTemplate",
        "targets": {
            "Instances-Target-1": {
                "resourceType": "aws:ec2:instance",
                "resourceArns": [
                    "arn:aws:ec2:us-west-2:123456789012:instance/i-12a3b4c56d78e9012"
                ],
                "selectionMode": "ALL"
            }
        },
        "actions": {
            "testaction": {
                "actionId": "aws:ec2:stop-instances",
                "parameters": {},
                "targets": {
                    "Instances": "Instances-Target-1"
                }
            }
        },
        "stopConditions": [
            {
                "source": "none"
            }
        ],
        "creationTime": 1616017191.124,
        "lastUpdateTime": 1616017331.51,
        "roleArn": "arn:aws:iam::123456789012:role/FISRole",
        "tags": {
        "key: "value"
        }
    }
}

For more information, see Experiment templates in the AWS Fault Injection Simulator User Guide.

Output

experimentTemplate -> (structure)

Information about the experiment template.

id -> (string)

The ID of the experiment template.

description -> (string)

The description for the experiment template.

targets -> (map)

The targets for the experiment.

key -> (string)

value -> (structure)

Describes a target for an experiment template.

resourceType -> (string)

The resource type.

resourceArns -> (list)

The Amazon Resource Names (ARNs) of the targets.

(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 template.

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.

actions -> (map)

The actions for the experiment.

key -> (string)

value -> (structure)

Describes an action for an experiment template.

actionId -> (string)

The ID of the action.

description -> (string)

A 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 the current action starts.

(string)

stopConditions -> (list)

The stop conditions for the experiment.

(structure)

Describes a stop condition for an experiment template.

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 the experiment template was created.

lastUpdateTime -> (timestamp)

The time the experiment template was last updated.

roleArn -> (string)

The Amazon Resource Name (ARN) of an IAM role.

tags -> (map)

The tags for the experiment template.

key -> (string)

value -> (string)