amazonka-finspace-data-2.0: Amazon FinSpace Public API SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.FinSpaceData.Types.ChangesetSummary

Description

 
Synopsis

Documentation

data ChangesetSummary Source #

A Changeset is unit of data in a Dataset.

See: newChangesetSummary smart constructor.

Constructors

ChangesetSummary' 

Fields

  • activeFromTimestamp :: Maybe Integer

    Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

  • activeUntilTimestamp :: Maybe Integer

    Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

  • changeType :: Maybe ChangeType

    Type that indicates how a Changeset is applied to a Dataset.

    • REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.
    • APPEND – Changeset is 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.
  • changesetArn :: Maybe Text

    The ARN identifier of the Changeset.

  • changesetId :: Maybe Text

    The unique identifier for a Changeset.

  • createTime :: Maybe Integer

    The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

  • datasetId :: Maybe Text

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

  • errorInfo :: Maybe ChangesetErrorInfo

    The structure with error messages.

  • formatParams :: Maybe (HashMap Text Text)

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

  • sourceParams :: Maybe (HashMap Text Text)

    Options that define the location of the data being ingested.

  • status :: Maybe IngestionStatus

    Status of the Changeset ingestion.

    • PENDING – Changeset is pending creation.
    • FAILED – Changeset creation has failed.
    • SUCCESS – Changeset creation has succeeded.
    • RUNNING – Changeset creation is running.
    • STOP_REQUESTED – User requested Changeset creation to stop.
  • updatedByChangesetId :: Maybe Text

    The unique identifier of the updated Changeset.

  • updatesChangesetId :: Maybe Text

    The unique identifier of the Changeset that is updated.

Instances

Instances details
FromJSON ChangesetSummary Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.ChangesetSummary

Generic ChangesetSummary Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.ChangesetSummary

Associated Types

type Rep ChangesetSummary :: Type -> Type #

Read ChangesetSummary Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.ChangesetSummary

Show ChangesetSummary Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.ChangesetSummary

NFData ChangesetSummary Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.ChangesetSummary

Methods

rnf :: ChangesetSummary -> () #

Eq ChangesetSummary Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.ChangesetSummary

Hashable ChangesetSummary Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.ChangesetSummary

type Rep ChangesetSummary Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.ChangesetSummary

type Rep ChangesetSummary = D1 ('MetaData "ChangesetSummary" "Amazonka.FinSpaceData.Types.ChangesetSummary" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "ChangesetSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "activeFromTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "activeUntilTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "changeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChangeType)))) :*: (S1 ('MetaSel ('Just "changesetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "changesetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :*: ((S1 ('MetaSel ('Just "datasetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "errorInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChangesetErrorInfo)) :*: S1 ('MetaSel ('Just "formatParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: ((S1 ('MetaSel ('Just "sourceParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IngestionStatus))) :*: (S1 ('MetaSel ('Just "updatedByChangesetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "updatesChangesetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newChangesetSummary :: ChangesetSummary Source #

Create a value of ChangesetSummary 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:activeFromTimestamp:ChangesetSummary', changesetSummary_activeFromTimestamp - Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

$sel:activeUntilTimestamp:ChangesetSummary', changesetSummary_activeUntilTimestamp - Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

$sel:changeType:ChangesetSummary', changesetSummary_changeType - Type that indicates how a Changeset is applied to a Dataset.

  • REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.
  • APPEND – Changeset is 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.

$sel:changesetArn:ChangesetSummary', changesetSummary_changesetArn - The ARN identifier of the Changeset.

$sel:changesetId:ChangesetSummary', changesetSummary_changesetId - The unique identifier for a Changeset.

$sel:createTime:ChangesetSummary', changesetSummary_createTime - The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

$sel:datasetId:ChangesetSummary', changesetSummary_datasetId - The unique identifier for the FinSpace Dataset in which the Changeset is created.

$sel:errorInfo:ChangesetSummary', changesetSummary_errorInfo - The structure with error messages.

$sel:formatParams:ChangesetSummary', changesetSummary_formatParams - Options that define the structure of the source file(s).

$sel:sourceParams:ChangesetSummary', changesetSummary_sourceParams - Options that define the location of the data being ingested.

$sel:status:ChangesetSummary', changesetSummary_status - Status of the Changeset ingestion.

  • PENDING – Changeset is pending creation.
  • FAILED – Changeset creation has failed.
  • SUCCESS – Changeset creation has succeeded.
  • RUNNING – Changeset creation is running.
  • STOP_REQUESTED – User requested Changeset creation to stop.

$sel:updatedByChangesetId:ChangesetSummary', changesetSummary_updatedByChangesetId - The unique identifier of the updated Changeset.

$sel:updatesChangesetId:ChangesetSummary', changesetSummary_updatesChangesetId - The unique identifier of the Changeset that is updated.

changesetSummary_activeFromTimestamp :: Lens' ChangesetSummary (Maybe Integer) Source #

Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

changesetSummary_activeUntilTimestamp :: Lens' ChangesetSummary (Maybe Integer) Source #

Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

changesetSummary_changeType :: Lens' ChangesetSummary (Maybe ChangeType) Source #

Type that indicates how a Changeset is applied to a Dataset.

  • REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.
  • APPEND – Changeset is 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.

changesetSummary_changesetArn :: Lens' ChangesetSummary (Maybe Text) Source #

The ARN identifier of the Changeset.

changesetSummary_changesetId :: Lens' ChangesetSummary (Maybe Text) Source #

The unique identifier for a Changeset.

changesetSummary_createTime :: Lens' ChangesetSummary (Maybe Integer) Source #

The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

changesetSummary_datasetId :: Lens' ChangesetSummary (Maybe Text) Source #

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

changesetSummary_formatParams :: Lens' ChangesetSummary (Maybe (HashMap Text Text)) Source #

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

changesetSummary_sourceParams :: Lens' ChangesetSummary (Maybe (HashMap Text Text)) Source #

Options that define the location of the data being ingested.

changesetSummary_status :: Lens' ChangesetSummary (Maybe IngestionStatus) Source #

Status of the Changeset ingestion.

  • PENDING – Changeset is pending creation.
  • FAILED – Changeset creation has failed.
  • SUCCESS – Changeset creation has succeeded.
  • RUNNING – Changeset creation is running.
  • STOP_REQUESTED – User requested Changeset creation to stop.

changesetSummary_updatedByChangesetId :: Lens' ChangesetSummary (Maybe Text) Source #

The unique identifier of the updated Changeset.

changesetSummary_updatesChangesetId :: Lens' ChangesetSummary (Maybe Text) Source #

The unique identifier of the Changeset that is updated.