GLOBUS FLOWS START
DESCRIPTION
Start a flow.
This creates a new run, and will return the run ID for monitoring and future interactions with that run of the flow. The input data will be validated against the Flow’s input schema if one is declared.
Use tags and labels to make runs searchable, and set monitors and managers to allow other users to interact with the run.
The notification policy defaults to "INACTIVE". You can set it to the full
set of statuses, as in
--activity-notification-policy 'INACTIVE,SUCCEEDED,FAILED'
Or pass a full notification policy document as JSON.
OPTIONS
-
--input
[JSON_FILE|JSON|file:JSON_FILE] -
The JSON input parameters used to start the flow.
The input document may be specified inline, or it may be a path to a JSON file, prefixed with "file:".
Example: Inline JSON:
--input '{"src": "~/source"}'
Example: Path to JSON file:
--input parameters.json
If unspecified, the default is an empty JSON object ('{}').
-
--label
TEXT -
A label to give the run.
-
--manager
TEXT -
A principal that may manage the execution of the run.
This option can be specified multiple times to create a list of run managers.
-
--monitor
TEXT -
A principal that may monitor the execution of the run.
This option can be specified multiple time to create a list of run monitors.
-
--tag
TEXT -
A tag to associate with the run.
This option can be used multiple times to create a list of tags.
-
--activity-notification-policy
[{INACTIVE,FAILED,SUCCEEDED}|JSON_FILE|JSON] -
The activity notification policy for the run.
This may be given as a comma-delimited list of statuses for notification; alternatively, this can also be provided as JSON data—or a path to a JSON file—containing a full notification policy document.
- -v, --verbose
-
Control level of output, make it more verbose.
- --quiet
-
Suppress non-essential output. This is higher precedence than
--verbose. - -h, --help
-
Show this message and exit.
-
-F, --format
[unix|json|text] -
Output format for stdout. Defaults to text.
-
--jmespath, --jq
TEXT -
A JMESPath expression to apply to json output. Forces the format to be json processed by this expression.
-
--map-http-status
TEXT -
Map HTTP statuses to any of these exit codes: 0,1,50-99. e.g. "404=50,403=51"
EXIT STATUS
0 on success.
1 if a network or server error occurred, unless --map-http-status has been used to change exit behavior on http error codes.
2 if the command was used improperly.
3 if the command was used on the wrong type of object, e.g. a collection command used on an endpoint.
4 if the command has authentication or authorization requirements which were not met, as in ConsentRequired errors or missing logins.