AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Supply Chain UpdateDataIntegrationFlow API operation.

Syntax

Update-SUPCHDataIntegrationFlow
-InstanceId <String>
-S3Target_BucketName <String>
-DatasetTarget_DatasetIdentifier <String>
-Options_DedupeRecord <Boolean>
-FieldPriority_Field <DataIntegrationFlowFieldPriorityDedupeField[]>
-Options_FileType <DataIntegrationFlowFileType>
-Options_LoadType <DataIntegrationFlowLoadType>
-Name <String>
-S3Target_Prefix <String>
-SqlTransformation_Query <String>
-Source <DataIntegrationFlowSource[]>
-Target_TargetType <DataIntegrationFlowTargetType>
-Transformation_TransformationType <DataIntegrationFlowTransformationType>
-DedupeStrategy_Type <DataIntegrationFlowDedupeStrategyType>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonSupplyChainConfig>

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.

Parameters

-ClientConfig <AmazonSupplyChainConfig>
Amazon.PowerShell.Cmdlets.SUPCH.AmazonSupplyChainClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DatasetTarget_DatasetIdentifier <String>
The dataset ARN.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_DatasetTarget_DatasetIdentifier
-DedupeStrategy_Type <DataIntegrationFlowDedupeStrategyType>
The type of the deduplication strategy.
  • FIELD_PRIORITY - Field priority configuration for the deduplication strategy specifies an ordered list of fields used to tie-break the data records sharing the same primary key values. Fields earlier in the list have higher priority for evaluation. For each field, the sort order determines whether to retain data record with larger or smaller field value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_DatasetTarget_Options_DedupeStrategy_Type
-FieldPriority_Field <DataIntegrationFlowFieldPriorityDedupeField[]>
The list of field names and their sort order for deduplication, arranged in descending priority from highest to lowest. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_DatasetTarget_Options_DedupeStrategy_FieldPriority_Fields
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceId <String>
The Amazon Web Services Supply Chain instance identifier.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Name <String>
The name of the DataIntegrationFlow to be updated.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_DedupeRecord <Boolean>
The option to perform deduplication on data records sharing same primary key values. If disabled, transformed data with duplicate primary key values will ingest into dataset, for datasets within asc namespace, such duplicates will cause ingestion fail. If enabled without dedupeStrategy, deduplication is done by retaining a random data record among those sharing the same primary key values. If enabled with dedupeStragtegy, the deduplication is done following the strategy.Note that target dataset may have partition configured, when dedupe is enabled, it only dedupe against primary keys and retain only one record out of those duplicates regardless of its partition status.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_DatasetTarget_Options_DedupeRecords
-Options_FileType <DataIntegrationFlowFileType>
The Amazon S3 file type in S3 options.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_S3Target_Options_FileType
-Options_LoadType <DataIntegrationFlowLoadType>
The target dataset's data load type. This only affects how source S3 files are selected in the S3-to-dataset flow.
  • REPLACE - Target dataset will get replaced with the new file added under the source s3 prefix.
  • INCREMENTAL - Target dataset will get updated with the up-to-date content under S3 prefix incorporating any file additions or removals there.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_DatasetTarget_Options_LoadType
-S3Target_BucketName <String>
The bucketName of the S3 target objects.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_S3Target_BucketName
-S3Target_Prefix <String>
The prefix of the S3 target objects.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_S3Target_Prefix
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Flow'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SupplyChain.Model.UpdateDataIntegrationFlowResponse). Specifying the name of a property of type Amazon.SupplyChain.Model.UpdateDataIntegrationFlowResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Source <DataIntegrationFlowSource[]>
The new source configurations for the DataIntegrationFlow. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSources
-SqlTransformation_Query <String>
The transformation SQL query body based on SparkSQL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTransformation_SqlTransformation_Query
-Target_TargetType <DataIntegrationFlowTargetType>
The DataIntegrationFlow target type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Transformation_TransformationType <DataIntegrationFlowTransformationType>
The DataIntegrationFlow transformation type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.SupplyChain.Model.DataIntegrationFlow or Amazon.SupplyChain.Model.UpdateDataIntegrationFlowResponse
This cmdlet returns an Amazon.SupplyChain.Model.DataIntegrationFlow object. The service call response (type Amazon.SupplyChain.Model.UpdateDataIntegrationFlowResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z