Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . quicksight ]

create-flow

Description

Creates a new flow in the specified Amazon Web Services account. Creates both a DRAFT and PUBLISHED (auto-published) version.

This operation is idempotent. Supply a ClientToken to safely retry without creating duplicate resources.

See also: AWS API Documentation

create-flow uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  create-flow
--aws-account-id <value>
--name <value>
[--description <value>]
--flow-definition <value>
[--permissions <value>]
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--aws-account-id (string)

The ID of the Amazon Web Services account where you want to create the flow.

--name (string)

The display name for the flow.

--description (string)

The description for the flow.

--flow-definition (document)

The definition of the flow, specifying the steps and configurations. This is the flow definition in Quick Flow’s internal format. The format is subject to change.

Note

Always derive or depend on the flow definition from the DescribeFlow operation to ensure you are working with the latest format.

JSON Syntax:

{...}

--permissions (list)

Initial permissions for the flow. If omitted, the flow is created without any permissions.

(structure)

A structure that contains the permission information for one principal against one flow.

Actions -> (list)

A list of actions that the principal can perform against the flow.

The following are the list of values to set a principal as a flow owner:

• quicksight:PublishFlow
• quicksight:GetFlow
• quicksight:UpdateFlowPermissions
• quicksight:GetFlowSession
• quicksight:StartFlowSession
• quicksight:StopFlowSession
• quicksight:UpdateFlowSession
• quicksight:UnpublishFlow
• quicksight:GetFlowStages
• quicksight:DeleteFlow
• quicksight:DescribeFlowPermissions
• quicksight:UpdateFlow
• quicksight:CreatePresignedUrl

The following are the list of values to set a principal as a flow viewer:

• quicksight:GetFlow
• quicksight:UpdateFlowSession
• quicksight:StartFlowSession
• quicksight:StopFlowSession
• quicksight:GetFlowSession
• quicksight:CreatePresignedUrl
• quicksight:GetFlowStages

(string)

Principal -> (string)

The Amazon Resource Name (ARN) of the principal. This can be an Amazon Quick user, group or namespace associated with the flow. Namespace principal can only be set as a viewer and will grant everyone in the same namespace viewer permissions.

Shorthand Syntax:

Actions=string,string,Principal=string ...

JSON Syntax:

[
  {
    "Actions": ["string", ...],
    "Principal": "string"
  }
  ...
]

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

Arn -> (string)

The Amazon Resource Name (ARN) of the flow.

FlowId -> (string)

The unique identifier of the flow.

RequestId -> (string)

The Amazon Web Services request ID for this operation.

Status -> (integer)

The HTTP status of the request.