Amazonka.FinSpaceData.UpdateChangeset

Updates a FinSpace Changeset.

Creating a Request

data UpdateChangeset

Request to update an existing changeset.

See: newUpdateChangeset smart constructor.

Constructors

UpdateChangeset'

Fields

• clientToken :: Maybe Text

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

• datasetId :: Text

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

• changesetId :: Text

  The unique identifier for the Changeset to update.

• sourceParams :: HashMap Text Text

  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.

• formatParams :: HashMap Text Text

  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.

Instances

ToJSON UpdateChangeset

Defined in Amazonka.FinSpaceData.UpdateChangeset

Methods

toJSON :: UpdateChangeset -> Value

toEncoding :: UpdateChangeset -> Encoding

toJSONList :: [UpdateChangeset] -> Value

toEncodingList :: [UpdateChangeset] -> Encoding

ToHeaders UpdateChangeset

Defined in Amazonka.FinSpaceData.UpdateChangeset

Methods

toHeaders :: UpdateChangeset -> [Header]

ToPath UpdateChangeset

Defined in Amazonka.FinSpaceData.UpdateChangeset

Methods

toPath :: UpdateChangeset -> ByteString

ToQuery UpdateChangeset

Defined in Amazonka.FinSpaceData.UpdateChangeset

Methods

toQuery :: UpdateChangeset -> QueryString

AWSRequest UpdateChangeset

Defined in Amazonka.FinSpaceData.UpdateChangeset

Associated Types

type AWSResponse UpdateChangeset

Methods

request :: (Service -> Service) -> UpdateChangeset -> Request UpdateChangeset

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateChangeset -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateChangeset)))

Generic UpdateChangeset

Defined in Amazonka.FinSpaceData.UpdateChangeset

Associated Types

type Rep UpdateChangeset :: Type -> Type

Methods

from :: UpdateChangeset -> Rep UpdateChangeset x

to :: Rep UpdateChangeset x -> UpdateChangeset

Read UpdateChangeset

Defined in Amazonka.FinSpaceData.UpdateChangeset

Methods

readsPrec :: Int -> ReadS UpdateChangeset

readList :: ReadS [UpdateChangeset]

readPrec :: ReadPrec UpdateChangeset

readListPrec :: ReadPrec [UpdateChangeset]

Show UpdateChangeset

Defined in Amazonka.FinSpaceData.UpdateChangeset

Methods

showsPrec :: Int -> UpdateChangeset -> ShowS

show :: UpdateChangeset -> String

showList :: [UpdateChangeset] -> ShowS

NFData UpdateChangeset

Defined in Amazonka.FinSpaceData.UpdateChangeset

Methods

rnf :: UpdateChangeset -> ()

Eq UpdateChangeset

Defined in Amazonka.FinSpaceData.UpdateChangeset

Methods

(==) :: UpdateChangeset -> UpdateChangeset -> Bool

(/=) :: UpdateChangeset -> UpdateChangeset -> Bool

Hashable UpdateChangeset

Defined in Amazonka.FinSpaceData.UpdateChangeset

Methods

hashWithSalt :: Int -> UpdateChangeset -> Int

hash :: UpdateChangeset -> Int

type AWSResponse UpdateChangeset

Defined in Amazonka.FinSpaceData.UpdateChangeset

type AWSResponse UpdateChangeset = UpdateChangesetResponse

type Rep UpdateChangeset

Defined in Amazonka.FinSpaceData.UpdateChangeset

type Rep UpdateChangeset = D1 ('MetaData "UpdateChangeset" "Amazonka.FinSpaceData.UpdateChangeset" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "UpdateChangeset'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "datasetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "changesetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "sourceParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text)) :*: S1 ('MetaSel ('Just "formatParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))))))

newUpdateChangeset

Arguments

:: Text

UpdateChangeset

-> Text

UpdateChangeset

-> UpdateChangeset

Create a value of UpdateChangeset with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:UpdateChangeset', updateChangeset_clientToken - A token that ensures idempotency. This token expires in 10 minutes.

UpdateChangeset, updateChangeset_datasetId - The unique identifier for the FinSpace Dataset in which the Changeset is created.

UpdateChangeset, updateChangeset_changesetId - The unique identifier for the Changeset to update.

UpdateChangeset, updateChangeset_sourceParams - 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.

UpdateChangeset, updateChangeset_formatParams - 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.

Request Lenses

updateChangeset_clientToken :: Lens' UpdateChangeset (Maybe Text)

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

updateChangeset_datasetId :: Lens' UpdateChangeset Text

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

updateChangeset_changesetId :: Lens' UpdateChangeset Text

The unique identifier for the Changeset to update.

updateChangeset_sourceParams :: Lens' UpdateChangeset (HashMap Text Text)

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.

updateChangeset_formatParams :: Lens' UpdateChangeset (HashMap Text Text)

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.

Destructuring the Response

data UpdateChangesetResponse

The response from a update changeset operation.

See: newUpdateChangesetResponse smart constructor.

Constructors

UpdateChangesetResponse'

Fields

• changesetId :: Maybe Text

  The unique identifier for the Changeset to update.

• datasetId :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateChangesetResponse

Defined in Amazonka.FinSpaceData.UpdateChangeset

Associated Types

type Rep UpdateChangesetResponse :: Type -> Type

Methods

from :: UpdateChangesetResponse -> Rep UpdateChangesetResponse x

to :: Rep UpdateChangesetResponse x -> UpdateChangesetResponse

Read UpdateChangesetResponse

Defined in Amazonka.FinSpaceData.UpdateChangeset

Methods

readsPrec :: Int -> ReadS UpdateChangesetResponse

readList :: ReadS [UpdateChangesetResponse]

readPrec :: ReadPrec UpdateChangesetResponse

readListPrec :: ReadPrec [UpdateChangesetResponse]

Show UpdateChangesetResponse

Defined in Amazonka.FinSpaceData.UpdateChangeset

Methods

showsPrec :: Int -> UpdateChangesetResponse -> ShowS

show :: UpdateChangesetResponse -> String

showList :: [UpdateChangesetResponse] -> ShowS

NFData UpdateChangesetResponse

Defined in Amazonka.FinSpaceData.UpdateChangeset

Methods

rnf :: UpdateChangesetResponse -> ()

Eq UpdateChangesetResponse

Defined in Amazonka.FinSpaceData.UpdateChangeset

Methods

(==) :: UpdateChangesetResponse -> UpdateChangesetResponse -> Bool

(/=) :: UpdateChangesetResponse -> UpdateChangesetResponse -> Bool

type Rep UpdateChangesetResponse

Defined in Amazonka.FinSpaceData.UpdateChangeset

type Rep UpdateChangesetResponse = D1 ('MetaData "UpdateChangesetResponse" "Amazonka.FinSpaceData.UpdateChangeset" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "UpdateChangesetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changesetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "datasetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateChangesetResponse

Arguments

:: Int

$sel:httpStatus:UpdateChangesetResponse'

-> UpdateChangesetResponse

Create a value of UpdateChangesetResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateChangeset, updateChangesetResponse_changesetId - The unique identifier for the Changeset to update.

UpdateChangeset, updateChangesetResponse_datasetId - The unique identifier for the FinSpace Dataset in which the Changeset is created.

$sel:httpStatus:UpdateChangesetResponse', updateChangesetResponse_httpStatus - The response's http status code.

Response Lenses

updateChangesetResponse_changesetId :: Lens' UpdateChangesetResponse (Maybe Text)

The unique identifier for the Changeset to update.

updateChangesetResponse_datasetId :: Lens' UpdateChangesetResponse (Maybe Text)

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

updateChangesetResponse_httpStatus :: Lens' UpdateChangesetResponse Int

The response's http status code.