AWS CLI Command Reference

[ aws . appflow ]

create-flow

Description

Enables your application to create a new flow using Amazon AppFlow. You must create a connector profile before calling this API. Please note that the Request Syntax below shows syntax for multiple destinations, however, you can only transfer data to one item in this list at a time. Amazon AppFlow does not currently support flows to multiple destinations at once.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-flow
--flow-name <value>
[--description <value>]
[--kms-arn <value>]
--trigger-config <value>
--source-flow-config <value>
--destination-flow-config-list <value>
--tasks <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--flow-name (string)

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

--description (string)

A description of the flow you want to create.

--kms-arn (string)

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don’t provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

--trigger-config (structure)

The trigger settings that determine how and when the flow runs.

triggerType -> (string)

Specifies the type of flow trigger. This can be OnDemand , Scheduled , or Event .

triggerProperties -> (structure)

Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.

Scheduled -> (structure)

Specifies the configuration details of a schedule-triggered flow as defined by the user.

scheduleExpression -> (string)

The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes) .

dataPullMode -> (string)

Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

scheduleStartTime -> (timestamp)

Specifies the scheduled start time for a schedule-triggered flow.

scheduleEndTime -> (timestamp)

Specifies the scheduled end time for a schedule-triggered flow.

timezone -> (string)

Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York .

scheduleOffset -> (long)

Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

Shorthand Syntax:

triggerType=string,triggerProperties={Scheduled={scheduleExpression=string,dataPullMode=string,scheduleStartTime=timestamp,scheduleEndTime=timestamp,timezone=string,scheduleOffset=long}}

JSON Syntax:

{
  "triggerType": "Scheduled"|"Event"|"OnDemand",
  "triggerProperties": {
    "Scheduled": {
      "scheduleExpression": "string",
      "dataPullMode": "Incremental"|"Complete",
      "scheduleStartTime": timestamp,
      "scheduleEndTime": timestamp,
      "timezone": "string",
      "scheduleOffset": long
    }
  }
}

--source-flow-config (structure)

The configuration that controls how Amazon AppFlow retrieves data from the source connector.

connectorType -> (string)

The type of connector, such as Salesforce, Amplitude, and so on.

connectorProfileName -> (string)

The name of the connector profile. This name must be unique for each connector profile in the AWS account.

sourceConnectorProperties -> (structure)

Specifies the information that is required to query a particular source connector.

Amplitude -> (structure)

Specifies the information that is required for querying Amplitude.

object -> (string)

The object specified in the Amplitude flow source.

Datadog -> (structure)

Specifies the information that is required for querying Datadog.

object -> (string)

The object specified in the Datadog flow source.

Dynatrace -> (structure)

Specifies the information that is required for querying Dynatrace.

object -> (string)

The object specified in the Dynatrace flow source.

GoogleAnalytics -> (structure)

Specifies the information that is required for querying Google Analytics.

object -> (string)

The object specified in the Google Analytics flow source.

InforNexus -> (structure)

Specifies the information that is required for querying Infor Nexus.

object -> (string)

The object specified in the Infor Nexus flow source.

Marketo -> (structure)

Specifies the information that is required for querying Marketo.

object -> (string)

The object specified in the Marketo flow source.

S3 -> (structure)

Specifies the information that is required for querying Amazon S3.

bucketName -> (string)

The Amazon S3 bucket name where the source files are stored.

bucketPrefix -> (string)

The object key for the Amazon S3 bucket in which the source files are stored.

Salesforce -> (structure)

Specifies the information that is required for querying Salesforce.

object -> (string)

The object specified in the Salesforce flow source.

enableDynamicFieldUpdate -> (boolean)

The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.

includeDeletedRecords -> (boolean)

Indicates whether Amazon AppFlow includes deleted files in the flow run.

ServiceNow -> (structure)

Specifies the information that is required for querying ServiceNow.

object -> (string)

The object specified in the ServiceNow flow source.

Singular -> (structure)

Specifies the information that is required for querying Singular.

object -> (string)

The object specified in the Singular flow source.

Slack -> (structure)

Specifies the information that is required for querying Slack.

object -> (string)

The object specified in the Slack flow source.

Trendmicro -> (structure)

Specifies the information that is required for querying Trend Micro.

object -> (string)

The object specified in the Trend Micro flow source.

Veeva -> (structure)

Specifies the information that is required for querying Veeva.

object -> (string)

The object specified in the Veeva flow source.

Zendesk -> (structure)

Specifies the information that is required for querying Zendesk.

object -> (string)

The object specified in the Zendesk flow source.

incrementalPullConfig -> (structure)

Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.

datetimeTypeFieldName -> (string)

A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.

Shorthand Syntax:

connectorType=string,connectorProfileName=string,sourceConnectorProperties={Amplitude={object=string},Datadog={object=string},Dynatrace={object=string},GoogleAnalytics={object=string},InforNexus={object=string},Marketo={object=string},S3={bucketName=string,bucketPrefix=string},Salesforce={object=string,enableDynamicFieldUpdate=boolean,includeDeletedRecords=boolean},ServiceNow={object=string},Singular={object=string},Slack={object=string},Trendmicro={object=string},Veeva={object=string},Zendesk={object=string}},incrementalPullConfig={datetimeTypeFieldName=string}

JSON Syntax:

{
  "connectorType": "Salesforce"|"Singular"|"Slack"|"Redshift"|"S3"|"Marketo"|"Googleanalytics"|"Zendesk"|"Servicenow"|"Datadog"|"Trendmicro"|"Snowflake"|"Dynatrace"|"Infornexus"|"Amplitude"|"Veeva"|"EventBridge"|"Upsolver",
  "connectorProfileName": "string",
  "sourceConnectorProperties": {
    "Amplitude": {
      "object": "string"
    },
    "Datadog": {
      "object": "string"
    },
    "Dynatrace": {
      "object": "string"
    },
    "GoogleAnalytics": {
      "object": "string"
    },
    "InforNexus": {
      "object": "string"
    },
    "Marketo": {
      "object": "string"
    },
    "S3": {
      "bucketName": "string",
      "bucketPrefix": "string"
    },
    "Salesforce": {
      "object": "string",
      "enableDynamicFieldUpdate": true|false,
      "includeDeletedRecords": true|false
    },
    "ServiceNow": {
      "object": "string"
    },
    "Singular": {
      "object": "string"
    },
    "Slack": {
      "object": "string"
    },
    "Trendmicro": {
      "object": "string"
    },
    "Veeva": {
      "object": "string"
    },
    "Zendesk": {
      "object": "string"
    }
  },
  "incrementalPullConfig": {
    "datetimeTypeFieldName": "string"
  }
}

--destination-flow-config-list (list)

The configuration that controls how Amazon AppFlow places data in the destination connector.

(structure)

Contains information about the configuration of destination connectors present in the flow.

connectorType -> (string)

The type of connector, such as Salesforce, Amplitude, and so on.

connectorProfileName -> (string)

The name of the connector profile. This name must be unique for each connector profile in the AWS account.

destinationConnectorProperties -> (structure)

This stores the information that is required to query a particular connector.

Redshift -> (structure)

The properties required to query Amazon Redshift.

object -> (string)

The object specified in the Amazon Redshift flow destination.

intermediateBucketName -> (string)

The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift.

bucketPrefix -> (string)

The object key for the bucket in which Amazon AppFlow places the destination files.

errorHandlingConfig -> (structure)

The settings that determine how Amazon AppFlow handles an error when placing data in the Amazon Redshift destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

failOnFirstDestinationError -> (boolean)

Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.

bucketPrefix -> (string)

Specifies the Amazon S3 bucket prefix.

bucketName -> (string)

Specifies the name of the Amazon S3 bucket.

S3 -> (structure)

The properties required to query Amazon S3.

bucketName -> (string)

The Amazon S3 bucket name in which Amazon AppFlow places the transferred data.

bucketPrefix -> (string)

The object key for the destination bucket in which Amazon AppFlow places the files.

s3OutputFormatConfig -> (structure)

The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.

fileType -> (string)

Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.

prefixConfig -> (structure)

Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date.

prefixType -> (string)

Determines the level of granularity that’s included in the prefix.

prefixFormat -> (string)

Determines the format of the prefix, and whether it applies to the file name, file path, or both.

aggregationConfig -> (structure)

The aggregation settings that you can use to customize the output format of your flow data.

aggregationType -> (string)

Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated.

Salesforce -> (structure)

The properties required to query Salesforce.

object -> (string)

The object specified in the Salesforce flow destination.

idFieldNames -> (list)

The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete.

(string)

errorHandlingConfig -> (structure)

The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

failOnFirstDestinationError -> (boolean)

Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.

bucketPrefix -> (string)

Specifies the Amazon S3 bucket prefix.

bucketName -> (string)

Specifies the name of the Amazon S3 bucket.

writeOperationType -> (string)

This specifies the type of write operation to be performed in Salesforce. When the value is UPSERT , then idFieldNames is required.

Snowflake -> (structure)

The properties required to query Snowflake.

object -> (string)

The object specified in the Snowflake flow destination.

intermediateBucketName -> (string)

The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake.

bucketPrefix -> (string)

The object key for the destination bucket in which Amazon AppFlow places the files.

errorHandlingConfig -> (structure)

The settings that determine how Amazon AppFlow handles an error when placing data in the Snowflake destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

failOnFirstDestinationError -> (boolean)

Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.

bucketPrefix -> (string)

Specifies the Amazon S3 bucket prefix.

bucketName -> (string)

Specifies the name of the Amazon S3 bucket.

EventBridge -> (structure)

The properties required to query Amazon EventBridge.

object -> (string)

The object specified in the Amazon EventBridge flow destination.

errorHandlingConfig -> (structure)

The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

failOnFirstDestinationError -> (boolean)

Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.

bucketPrefix -> (string)

Specifies the Amazon S3 bucket prefix.

bucketName -> (string)

Specifies the name of the Amazon S3 bucket.

Upsolver -> (structure)

The properties required to query Upsolver.

bucketName -> (string)

The Upsolver Amazon S3 bucket name in which Amazon AppFlow places the transferred data.

bucketPrefix -> (string)

The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow places the files.

s3OutputFormatConfig -> (structure)

The configuration that determines how data is formatted when Upsolver is used as the flow destination.

fileType -> (string)

Indicates the file type that Amazon AppFlow places in the Upsolver Amazon S3 bucket.

prefixConfig -> (structure)

Determines the prefix that Amazon AppFlow applies to the destination folder name. You can name your destination folders according to the flow frequency and date.

prefixType -> (string)

Determines the level of granularity that’s included in the prefix.

prefixFormat -> (string)

Determines the format of the prefix, and whether it applies to the file name, file path, or both.

aggregationConfig -> (structure)

The aggregation settings that you can use to customize the output format of your flow data.

aggregationType -> (string)

Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated.

JSON Syntax:

[
  {
    "connectorType": "Salesforce"|"Singular"|"Slack"|"Redshift"|"S3"|"Marketo"|"Googleanalytics"|"Zendesk"|"Servicenow"|"Datadog"|"Trendmicro"|"Snowflake"|"Dynatrace"|"Infornexus"|"Amplitude"|"Veeva"|"EventBridge"|"Upsolver",
    "connectorProfileName": "string",
    "destinationConnectorProperties": {
      "Redshift": {
        "object": "string",
        "intermediateBucketName": "string",
        "bucketPrefix": "string",
        "errorHandlingConfig": {
          "failOnFirstDestinationError": true|false,
          "bucketPrefix": "string",
          "bucketName": "string"
        }
      },
      "S3": {
        "bucketName": "string",
        "bucketPrefix": "string",
        "s3OutputFormatConfig": {
          "fileType": "CSV"|"JSON"|"PARQUET",
          "prefixConfig": {
            "prefixType": "FILENAME"|"PATH"|"PATH_AND_FILENAME",
            "prefixFormat": "YEAR"|"MONTH"|"DAY"|"HOUR"|"MINUTE"
          },
          "aggregationConfig": {
            "aggregationType": "None"|"SingleFile"
          }
        }
      },
      "Salesforce": {
        "object": "string",
        "idFieldNames": ["string", ...],
        "errorHandlingConfig": {
          "failOnFirstDestinationError": true|false,
          "bucketPrefix": "string",
          "bucketName": "string"
        },
        "writeOperationType": "INSERT"|"UPSERT"|"UPDATE"
      },
      "Snowflake": {
        "object": "string",
        "intermediateBucketName": "string",
        "bucketPrefix": "string",
        "errorHandlingConfig": {
          "failOnFirstDestinationError": true|false,
          "bucketPrefix": "string",
          "bucketName": "string"
        }
      },
      "EventBridge": {
        "object": "string",
        "errorHandlingConfig": {
          "failOnFirstDestinationError": true|false,
          "bucketPrefix": "string",
          "bucketName": "string"
        }
      },
      "Upsolver": {
        "bucketName": "string",
        "bucketPrefix": "string",
        "s3OutputFormatConfig": {
          "fileType": "CSV"|"JSON"|"PARQUET",
          "prefixConfig": {
            "prefixType": "FILENAME"|"PATH"|"PATH_AND_FILENAME",
            "prefixFormat": "YEAR"|"MONTH"|"DAY"|"HOUR"|"MINUTE"
          },
          "aggregationConfig": {
            "aggregationType": "None"|"SingleFile"
          }
        }
      }
    }
  }
  ...
]

--tasks (list)

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

(structure)

A class for modeling different type of tasks. Task implementation varies based on the TaskType .

sourceFields -> (list)

The source fields to which a particular task is applied.

(string)

connectorOperator -> (structure)

The operation to be performed on the provided source fields.

Amplitude -> (string)

The operation to be performed on the provided Amplitude source fields.

Datadog -> (string)

The operation to be performed on the provided Datadog source fields.

Dynatrace -> (string)

The operation to be performed on the provided Dynatrace source fields.

GoogleAnalytics -> (string)

The operation to be performed on the provided Google Analytics source fields.

InforNexus -> (string)

The operation to be performed on the provided Infor Nexus source fields.

Marketo -> (string)

The operation to be performed on the provided Marketo source fields.

S3 -> (string)

The operation to be performed on the provided Amazon S3 source fields.

Salesforce -> (string)

The operation to be performed on the provided Salesforce source fields.

ServiceNow -> (string)

The operation to be performed on the provided ServiceNow source fields.

Singular -> (string)

The operation to be performed on the provided Singular source fields.

Slack -> (string)

The operation to be performed on the provided Slack source fields.

Trendmicro -> (string)

The operation to be performed on the provided Trend Micro source fields.

Veeva -> (string)

The operation to be performed on the provided Veeva source fields.

Zendesk -> (string)

The operation to be performed on the provided Zendesk source fields.

destinationField -> (string)

A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.

taskType -> (string)

Specifies the particular task implementation that Amazon AppFlow performs.

taskProperties -> (map)

A map used to store task-related information. The execution service looks for particular information based on the TaskType .

key -> (string)

value -> (string)

Shorthand Syntax:

sourceFields=string,string,connectorOperator={Amplitude=string,Datadog=string,Dynatrace=string,GoogleAnalytics=string,InforNexus=string,Marketo=string,S3=string,Salesforce=string,ServiceNow=string,Singular=string,Slack=string,Trendmicro=string,Veeva=string,Zendesk=string},destinationField=string,taskType=string,taskProperties={KeyName1=string,KeyName2=string} ...

JSON Syntax:

[
  {
    "sourceFields": ["string", ...],
    "connectorOperator": {
      "Amplitude": "BETWEEN",
      "Datadog": "PROJECTION"|"BETWEEN"|"EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
      "Dynatrace": "PROJECTION"|"BETWEEN"|"EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
      "GoogleAnalytics": "PROJECTION"|"BETWEEN",
      "InforNexus": "PROJECTION"|"BETWEEN"|"EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
      "Marketo": "PROJECTION"|"LESS_THAN"|"GREATER_THAN"|"BETWEEN"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
      "S3": "PROJECTION"|"LESS_THAN"|"GREATER_THAN"|"BETWEEN"|"LESS_THAN_OR_EQUAL_TO"|"GREATER_THAN_OR_EQUAL_TO"|"EQUAL_TO"|"NOT_EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
      "Salesforce": "PROJECTION"|"LESS_THAN"|"CONTAINS"|"GREATER_THAN"|"BETWEEN"|"LESS_THAN_OR_EQUAL_TO"|"GREATER_THAN_OR_EQUAL_TO"|"EQUAL_TO"|"NOT_EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
      "ServiceNow": "PROJECTION"|"CONTAINS"|"LESS_THAN"|"GREATER_THAN"|"BETWEEN"|"LESS_THAN_OR_EQUAL_TO"|"GREATER_THAN_OR_EQUAL_TO"|"EQUAL_TO"|"NOT_EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
      "Singular": "PROJECTION"|"EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
      "Slack": "PROJECTION"|"LESS_THAN"|"GREATER_THAN"|"BETWEEN"|"LESS_THAN_OR_EQUAL_TO"|"GREATER_THAN_OR_EQUAL_TO"|"EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
      "Trendmicro": "PROJECTION"|"EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
      "Veeva": "PROJECTION"|"LESS_THAN"|"GREATER_THAN"|"CONTAINS"|"BETWEEN"|"LESS_THAN_OR_EQUAL_TO"|"GREATER_THAN_OR_EQUAL_TO"|"EQUAL_TO"|"NOT_EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
      "Zendesk": "PROJECTION"|"GREATER_THAN"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP"
    },
    "destinationField": "string",
    "taskType": "Arithmetic"|"Filter"|"Map"|"Mask"|"Merge"|"Truncate"|"Validate",
    "taskProperties": {"VALUE"|"VALUES"|"DATA_TYPE"|"UPPER_BOUND"|"LOWER_BOUND"|"SOURCE_DATA_TYPE"|"DESTINATION_DATA_TYPE"|"VALIDATION_ACTION"|"MASK_VALUE"|"MASK_LENGTH"|"TRUNCATE_LENGTH"|"MATH_OPERATION_FIELDS_ORDER"|"CONCAT_FORMAT"|"SUBFIELD_CATEGORY_MAP": "string"
      ...}
  }
  ...
]

--tags (map)

The tags used to organize, track, or control access for your flow.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

flowArn -> (string)

The flow’s Amazon Resource Name (ARN).

flowStatus -> (string)

Indicates the current status of the flow.

© Copyright 2018, Amazon Web Services. Created using Sphinx.