GLOBUS FLOWS CREATE

NAME

globus flows create - Create a flow.

SYNOPSIS

globus flows create [OPTIONS] TITLE DEFINITION

DESCRIPTION

Create a new flow.

TITLE is the name of the flow.

DEFINITION is the JSON document that defines the flow’s instructions. The definition document may be specified inline, or it may be a path to a JSON file.

Example: Inline JSON:
    globus flows create 'My Cool Flow' \
'{{"StartAt": "a", "States": {{"a": {{"Type": "Pass", "End": true}}}}}}'
Example: Path to JSON file:
globus flows create 'My Other Flow' definition.json

OPTIONS

--input-schema [JSON_FILE|JSON|file:JSON_FILE]

The JSON input schema that governs the parameters used to start the flow.

The input document may be specified inline, or it may be a path to a JSON file.
Example: Inline JSON:
    --input-schema '{"properties": {"src": {"type": "string"}}}'
Example: Path to JSON file:
    --input-schema schema.json

If unspecified, the default is an empty JSON object ('{}').

--subtitle TEXT

A concise summary of the flow’s purpose.

--description TEXT

A detailed description of the flow’s purpose.

--administrator TEXT

A principal that may perform administrative operations on the flow (e.g., update, delete).

This option can be specified multiple times to create a list of flow administrators.

--starter TEXT

A principal that may start a new run of the flow.

Use "all_authenticated_users" to allow any authenticated user to start a new run of the flow.

This option can be specified multiple times to create a list of flow starters.

--viewer TEXT

A principal that may view the flow.

Use "public" to make the flow visible to everyone.

This option can be specified multiple times to create a list of flow viewers.

--keyword TEXT

A term used to help discover this flow when browsing and searching.

This option can be specified multiple times to create a list of keywords.

--subscription-id UUID

Set a subscription_id for the flow, marking it as subscription tier.

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