libZSservicesZSamazonka-finspace-dataZSamazonka-finspace-data
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.FinSpaceData.CreateChangeset

Description

Creates a new changeset in a FinSpace dataset.

Synopsis

Creating a Request

data CreateChangeset Source #

See: newCreateChangeset smart constructor.

Constructors

CreateChangeset' 

Fields

  • formatParams :: Maybe (HashMap Text Text)

    Options that define the structure of the source file(s).

  • formatType :: Maybe FormatType

    Format type of the input files being loaded into the changeset.

  • tags :: Maybe (HashMap Text Text)

    Metadata tags to apply to this changeset.

  • datasetId :: Text

    The unique identifier for the FinSpace dataset in which the changeset will be created.

  • changeType :: ChangeType

    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.
  • sourceType :: SourceType

    Type of the data source from which the files to create the changeset will be sourced.

    • S3 - Amazon S3.
  • sourceParams :: HashMap Text Text

    Source path from which the files to create the changeset will be sourced.

Instances

Instances details
Eq CreateChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

Read CreateChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

Show CreateChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

Generic CreateChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

Associated Types

type Rep CreateChangeset :: Type -> Type #

NFData CreateChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

Methods

rnf :: CreateChangeset -> () #

Hashable CreateChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

ToJSON CreateChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

AWSRequest CreateChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

Associated Types

type AWSResponse CreateChangeset #

ToHeaders CreateChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

ToPath CreateChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

ToQuery CreateChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

type Rep CreateChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

type AWSResponse CreateChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

newCreateChangeset Source #

Create a value of CreateChangeset 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:formatParams:CreateChangeset', createChangeset_formatParams - Options that define the structure of the source file(s).

$sel:formatType:CreateChangeset', createChangeset_formatType - Format type of the input files being loaded into the changeset.

$sel:tags:CreateChangeset', createChangeset_tags - Metadata tags to apply to this changeset.

$sel:datasetId:CreateChangeset', createChangeset_datasetId - The unique identifier for the FinSpace dataset in which the changeset will be created.

$sel:changeType:CreateChangeset', createChangeset_changeType - 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.

$sel:sourceType:CreateChangeset', createChangeset_sourceType - Type of the data source from which the files to create the changeset will be sourced.

  • S3 - Amazon S3.

$sel:sourceParams:CreateChangeset', createChangeset_sourceParams - Source path from which the files to create the changeset will be sourced.

Request Lenses

createChangeset_formatParams :: Lens' CreateChangeset (Maybe (HashMap Text Text)) Source #

Options that define the structure of the source file(s).

createChangeset_formatType :: Lens' CreateChangeset (Maybe FormatType) Source #

Format type of the input files being loaded into the changeset.

createChangeset_tags :: Lens' CreateChangeset (Maybe (HashMap Text Text)) Source #

Metadata tags to apply to this changeset.

createChangeset_datasetId :: Lens' CreateChangeset Text Source #

The unique identifier for the FinSpace dataset in which the changeset will be created.

createChangeset_changeType :: Lens' CreateChangeset ChangeType Source #

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.

createChangeset_sourceType :: Lens' CreateChangeset SourceType Source #

Type of the data source from which the files to create the changeset will be sourced.

  • S3 - Amazon S3.

createChangeset_sourceParams :: Lens' CreateChangeset (HashMap Text Text) Source #

Source path from which the files to create the changeset will be sourced.

Destructuring the Response

data CreateChangesetResponse Source #

See: newCreateChangesetResponse smart constructor.

Constructors

CreateChangesetResponse' 

Fields

Instances

Instances details
Eq CreateChangesetResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

Read CreateChangesetResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

Show CreateChangesetResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

Generic CreateChangesetResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

Associated Types

type Rep CreateChangesetResponse :: Type -> Type #

NFData CreateChangesetResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

Methods

rnf :: CreateChangesetResponse -> () #

type Rep CreateChangesetResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreateChangeset

type Rep CreateChangesetResponse = D1 ('MetaData "CreateChangesetResponse" "Amazonka.FinSpaceData.CreateChangeset" "libZSservicesZSamazonka-finspace-dataZSamazonka-finspace-data" 'False) (C1 ('MetaCons "CreateChangesetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changeset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChangesetInfo)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateChangesetResponse Source #

Create a value of CreateChangesetResponse 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:changeset:CreateChangesetResponse', createChangesetResponse_changeset - Returns the changeset details.

$sel:httpStatus:CreateChangesetResponse', createChangesetResponse_httpStatus - The response's http status code.

Response Lenses