create-data-integration-flow¶

Description¶

Enables you to programmatically create a data pipeline to ingest data from source systems such as Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API.

Synopsis¶

  create-data-integration-flow
--instance-id <value>
--name <value>
--sources <value>
--transformation <value>
--target <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--instance-id (string)

The Amazon Web Services Supply Chain instance identifier.

--name (string)

Name of the DataIntegrationFlow.

--sources (list)

The source configurations for DataIntegrationFlow.

(structure)

The DataIntegrationFlow source parameters.

sourceType -> (string)

The DataIntegrationFlow source type.

sourceName -> (string)

The DataIntegrationFlow source name that can be used as table alias in SQL transformation query.

s3Source -> (structure)

The S3 DataIntegrationFlow source.

bucketName -> (string)

The bucketName of the S3 source objects.

prefix -> (string)

The prefix of the S3 source objects.

options -> (structure)

The other options of the S3 DataIntegrationFlow source.

fileType -> (string)

The Amazon S3 file type in S3 options.

datasetSource -> (structure)

The dataset DataIntegrationFlow source.

datasetIdentifier -> (string)

The ARN of the dataset.

options -> (structure)

The dataset DataIntegrationFlow source options.

loadType -> (string)

The dataset data load type in dataset options.

dedupeRecords -> (boolean)

The dataset load option to remove duplicates.

Shorthand Syntax:

sourceType=string,sourceName=string,s3Source={bucketName=string,prefix=string,options={fileType=string}},datasetSource={datasetIdentifier=string,options={loadType=string,dedupeRecords=boolean}} ...

JSON Syntax:

[
  {
    "sourceType": "S3"|"DATASET",
    "sourceName": "string",
    "s3Source": {
      "bucketName": "string",
      "prefix": "string",
      "options": {
        "fileType": "CSV"|"PARQUET"|"JSON"
      }
    },
    "datasetSource": {
      "datasetIdentifier": "string",
      "options": {
        "loadType": "INCREMENTAL"|"REPLACE",
        "dedupeRecords": true|false
      }
    }
  }
  ...
]

--transformation (structure)

The transformation configurations for DataIntegrationFlow.

transformationType -> (string)

The DataIntegrationFlow transformation type.

sqlTransformation -> (structure)

The SQL DataIntegrationFlow transformation configuration.

query -> (string)

The transformation SQL query body based on SparkSQL.

Shorthand Syntax:

transformationType=string,sqlTransformation={query=string}

JSON Syntax:

{
  "transformationType": "SQL"|"NONE",
  "sqlTransformation": {
    "query": "string"
  }
}

--target (structure)

The target configurations for DataIntegrationFlow.

targetType -> (string)

The DataIntegrationFlow target type.

s3Target -> (structure)

The S3 DataIntegrationFlow target.

bucketName -> (string)

The bucketName of the S3 target objects.

prefix -> (string)

The prefix of the S3 target objects.

options -> (structure)

The S3 DataIntegrationFlow target options.

fileType -> (string)

The Amazon S3 file type in S3 options.

datasetTarget -> (structure)

The dataset DataIntegrationFlow target.

datasetIdentifier -> (string)

The dataset ARN.

options -> (structure)

The dataset DataIntegrationFlow target options.

loadType -> (string)

The dataset data load type in dataset options.

dedupeRecords -> (boolean)

The dataset load option to remove duplicates.

Shorthand Syntax:

targetType=string,s3Target={bucketName=string,prefix=string,options={fileType=string}},datasetTarget={datasetIdentifier=string,options={loadType=string,dedupeRecords=boolean}}

JSON Syntax:

{
  "targetType": "S3"|"DATASET",
  "s3Target": {
    "bucketName": "string",
    "prefix": "string",
    "options": {
      "fileType": "CSV"|"PARQUET"|"JSON"
    }
  },
  "datasetTarget": {
    "datasetIdentifier": "string",
    "options": {
      "loadType": "INCREMENTAL"|"REPLACE",
      "dedupeRecords": true|false
    }
  }
}

--tags (map)

The tags of the DataIntegrationFlow to be created

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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

instanceId -> (string)

The Amazon Web Services Supply Chain instance identifier.

name -> (string)

The name of the DataIntegrationFlow created.

Table of Contents

Feedback

User Guide

create-data-integration-flow¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶