get-experiment-template¶
Description¶
Gets information about the specified experiment template.
See also: AWS API Documentation
Synopsis¶
get-experiment-template
--id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--id (string)
The ID of the experiment template.
--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
on
off
auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
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.
parameters -> (map)
The resource type parameters.
key -> (string)
value -> (string)
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)
logConfiguration -> (structure)
The configuration for experiment logging.
cloudWatchLogsConfiguration -> (structure)
The configuration for experiment logging to Amazon CloudWatch Logs.
logGroupArn -> (string)
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
s3Configuration -> (structure)
The configuration for experiment logging to Amazon S3.
bucketName -> (string)
The name of the destination bucket.
prefix -> (string)
The bucket prefix.
logSchemaVersion -> (integer)
The schema version.