Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . supplychain ]

update-data-integration-flow¶

Description¶

Enables you to programmatically update an existing data pipeline to ingest data from the 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¶

  update-data-integration-flow
--instance-id <value>
--name <value>
[--sources <value>]
[--transformation <value>]
[--target <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>]

Options¶

--instance-id (string)

The Amazon Web Services Supply Chain instance identifier.

--name (string)

The name of the DataIntegrationFlow to be updated.

--sources (list)

The new source configurations for the 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 new transformation configurations for the 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 new target configurations for the 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
    }
  }
}

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

Output¶

flow -> (structure)

The details of the updated DataIntegrationFlow.

instanceId -> (string)

The DataIntegrationFlow instance ID.

name -> (string)

The DataIntegrationFlow name.

sources -> (list)

The DataIntegrationFlow source configurations.

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

transformation -> (structure)

The DataIntegrationFlow transformation configurations.

transformationType -> (string)

The DataIntegrationFlow transformation type.

sqlTransformation -> (structure)

The SQL DataIntegrationFlow transformation configuration.

query -> (string)

The transformation SQL query body based on SparkSQL.

target -> (structure)

The DataIntegrationFlow target configuration.

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.

createdTime -> (timestamp)

The DataIntegrationFlow creation timestamp.

lastModifiedTime -> (timestamp)

The DataIntegrationFlow last modified timestamp.

Table Of Contents

Feedback

User Guide

Note:

update-data-integration-flow¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶