[ aws . fis ]

get-action

Description

Gets information about the specified FIS action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--id (string)

The ID of the action.

--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 action details

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

aws fis get-action \
    --id aws:ec2:stop-instances

Output:

{
    "action": {
        "id": "aws:ec2:stop-instances",
        "description": "Stop the specified EC2 instances.",
        "parameters": {
            "startInstancesAfterDuration": {
                "description": "The time to wait before restarting the instances (ISO 8601 duration).",
                "required": false
            }
        },
        "targets": {
            "Instances": {
                "resourceType": "aws:ec2:instance"
            }
        },
        "tags": {}
    }
}

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

Output

action -> (structure)

Information about the action.

id -> (string)

The ID of the action.

description -> (string)

The description for the action.

parameters -> (map)

The action parameters, if applicable.

key -> (string)

value -> (structure)

Describes a parameter for an action.

description -> (string)

The parameter description.

required -> (boolean)

Indicates whether the parameter is required.

targets -> (map)

The supported targets for the action.

key -> (string)

value -> (structure)

Describes a target for an action.

resourceType -> (string)

The resource type of the target.

tags -> (map)

The tags for the action.

key -> (string)

value -> (string)