GLOBUS FLOWS UPDATE

NAME

globus flows update - Update a flow.

SYNOPSIS

globus flows update [OPTIONS] FLOW_ID

DESCRIPTION

Update a flow.

OPTIONS

--title TEXT

The name of the flow.

--definition [JSON_FILE|JSON|file:JSON_FILE]

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:
--definition '{{"StartAt": "a", "States": {{"a": {{"Type": "Pass", "End": true}}}}}}'
Example: Path to JSON file:
--definition definition.json
--owner TEXT

Assign ownership to your Globus Auth principal ID.

This option can only be used to take ownership of a flow, and your Globus Auth principal ID must already be a flow administrator.

This option cannot currently be used to assign ownership to an arbitrary user.

--subtitle TEXT

A concise summary of the flow’s purpose.

--description TEXT

A detailed description of the flow’s purpose.

--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 ('{}').

--administrators TEXT,TEXT,…​

A comma-separated list of flow administrators.

This must a list of Globus Auth group or identity IDs. Passing an empty string will clear any existing flow administrators.

--starters TEXT,TEXT,…​

A comma-separated list of flow starters.

This must a list of Globus Auth group or identity IDs. In addition, "all_authenticated_users" is an allowed value.

Passing an empty string will clear any existing flow starters.

--viewers TEXT,TEXT,…​

A comma-separated list of flow viewers.

This must a list of Globus Auth group or identity IDs. In addition, "public" is an allowed value.

Passing an empty string will clear any existing flow viewers.

--keywords TEXT,TEXT,…​

A comma-separated list of keywords.

Passing an empty string will clear any existing keywords.

--subscription-id SUBSCRIPTION_ID

A subscription ID to assign to the flow.

The value may be a UUID or the word "DEFAULT".

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