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 FinSpace Public API CreateChangeset API operation.

Syntax

New-FNSPChangeset
-ChangeType <ChangeType>
-DatasetId <String>
-FormatParam <Hashtable>
-SourceParam <Hashtable>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonFinSpaceDataConfig>

Description

Creates a new Changeset in a FinSpace Dataset.

This operation is deprecated.

Parameters

-ChangeType <ChangeType>
The option to indicate how a Changeset will be applied to a Dataset.
  • REPLACE – Changeset will be considered as a replacement to all prior loaded Changesets.
  • APPEND – Changeset will be considered as an addition to the end of all prior loaded Changesets.
  • MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonFinSpaceDataConfig>
Amazon.PowerShell.Cmdlets.FNSP.AmazonFinSpaceDataClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A token that ensures idempotency. This token expires in 10 minutes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DatasetId <String>
The unique identifier for the FinSpace Dataset where the Changeset will be created.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
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)
-FormatParam <Hashtable>
Options that define the structure of the source file(s) including the format type (formatType), header row (withHeader), data separation character (separator) and the type of compression (compression). formatType is a required attribute and can have the following values:
  • PARQUET – Parquet source file format.
  • CSV – CSV source file format.
  • JSON – JSON source file format.
  • XML – XML source file format.
Here is an example of how you could specify the formatParams: "formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" } Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following: { "withHeader": "true", "separator": "," } For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormatParams
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.CreateChangesetResponse). Specifying the name of a property of type Amazon.FinSpaceData.Model.CreateChangesetResponse 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)
-SourceParam <Hashtable>
Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).Both s3SourcePath and sourceType are required attributes.Here is an example of how you could specify the sourceParams: "sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" } The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace API section.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParams

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

This cmdlet returns an Amazon.FinSpaceData.Model.CreateChangesetResponse object containing multiple properties.

Supported Version

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