Class: Aws::FinSpaceData::Types::UpdateChangesetRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb

Overview

Request to update an existing changeset.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#changeset_id ⇒ String

The unique identifier for the Changeset to update.

Returns:

  • (String) 


2396
2397
2398
2399
2400
2401
2402
2403
2404
 
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2396

class UpdateChangesetRequest < Struct.new(
  :client_token,
  :dataset_id,
  :changeset_id,
  :source_params,
  :format_params)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A token that ensures idempotency. This token expires in 10 minutes.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


2396
2397
2398
2399
2400
2401
2402
2403
2404
 
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2396

class UpdateChangesetRequest < Struct.new(
  :client_token,
  :dataset_id,
  :changeset_id,
  :source_params,
  :format_params)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_id ⇒ String

The unique identifier for the FinSpace Dataset in which the Changeset is created.

Returns:

  • (String) 


2396
2397
2398
2399
2400
2401
2402
2403
2404
 
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2396

class UpdateChangesetRequest < Struct.new(
  :client_token,
  :dataset_id,
  :changeset_id,
  :source_params,
  :format_params)
  SENSITIVE = []
  include Aws::Structure
end

#format_params ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) 


2396
2397
2398
2399
2400
2401
2402
2403
2404
 
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2396

class UpdateChangesetRequest < Struct.new(
  :client_token,
  :dataset_id,
  :changeset_id,
  :source_params,
  :format_params)
  SENSITIVE = []
  include Aws::Structure
end

#source_params ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


2396
2397
2398
2399
2400
2401
2402
2403
2404
 
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2396

class UpdateChangesetRequest < Struct.new(
  :client_token,
  :dataset_id,
  :changeset_id,
  :source_params,
  :format_params)
  SENSITIVE = []
  include Aws::Structure
end