start-flow¶
Description¶
Activates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
start-flow
--flow-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--flow-name (string)
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
--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.
Output¶
flowArn -> (string)
The flow’s Amazon Resource Name (ARN).
flowStatus -> (string)
Indicates the current status of the flow.
executionId -> (string)
Returns the internal execution ID of an on-demand flow when the flow is started. For scheduled or event-triggered flows, this value is null.