list-readyflows¶

Description¶

Lists ready flows.

list-readyflows is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.

Synopsis¶

  list-readyflows
[--search-term <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--search-term (string)

Search term by which to filter (optional)

--max-items (integer)

The total number of items to return. If the total number of items available is more than the value specified in max-items then a nextToken will be provided in the output that you can use to resume pagination. This nextToken response element should not be used directly outside of the CDP CLI. This option cannnot be combined with the no-paginate CLI option. If no max-items value is specified, then a default value of 20 is used.

--starting-token (string)

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

--page-size (integer)

The size of each page. Generally this does not need to be set and the default page size used is appropriate.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

readyflows -> (array)

The ready flows

item -> (object)

A summarized version of a ready flow, mostly useful in listing flows

readyflowCrn -> (string)

The ready flow CRN

name -> (string)

The ready flow name

summary -> (string)

The ready flow summary

source -> (string)

The ready flow source

destination -> (string)

The ready flow destination

latestVersion -> (integer)

The latest version of the ready flow

imported -> (boolean)

Whether the ready flow has been imported into the current account

importedArtifactCrn -> (string)

The crn of the imported ready flow, used to look up its details

nextToken -> (string)

The page token for requesting the next page of results.

Form Factors¶

public