Class: Aws::FinSpaceData::Types::CreateChangesetRequest

Inherits:

Struct

• Object
• Struct
• Aws::FinSpaceData::Types::CreateChangesetRequest

Includes:

Structure

Defined in:

lib/aws-sdk-finspacedata/types.rb

Overview

The request for a CreateChangeset operation.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #change_type ⇒ String

  The option to indicate how a Changeset will be applied to a Dataset.

• #client_token ⇒ String

  A token that ensures idempotency.

• #dataset_id ⇒ String

  The unique identifier for the FinSpace Dataset where the Changeset will be created.

• #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`).

• #source_params ⇒ Hash<String,String>

  Options that define the location of the data being ingested (‘s3SourcePath`) and the source of the changeset (`sourceType`).

Instance Attribute Details

#change_type ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-finspacedata/types.rb', line 386

class CreateChangesetRequest < Struct.new(
  :client_token,
  :dataset_id,
  :change_type,
  :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)

# File 'lib/aws-sdk-finspacedata/types.rb', line 386

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

#dataset_id ⇒ String

The unique identifier for the FinSpace Dataset where the Changeset will be created.

Returns:

• (String)

# File 'lib/aws-sdk-finspacedata/types.rb', line 386

class CreateChangesetRequest < Struct.new(
  :client_token,
  :dataset_id,
  :change_type,
  :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.

[1]: docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-finspacedata/types.rb', line 386

class CreateChangesetRequest < Struct.new(
  :client_token,
  :dataset_id,
  :change_type,
  :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 API] section.

[1]: docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-finspacedata/types.rb', line 386

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