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

Description

Get information about a Changeset.

Synopsis

Creating a Request

data GetChangeset Source #

Request to describe a changeset.

See: newGetChangeset smart constructor.

Constructors

GetChangeset' 

Fields

  • datasetId :: Text

    The unique identifier for the FinSpace Dataset where the Changeset is created.

  • changesetId :: Text

    The unique identifier of the Changeset for which to get data.

Instances

Instances details
ToHeaders GetChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

ToPath GetChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

ToQuery GetChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

AWSRequest GetChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

Associated Types

type AWSResponse GetChangeset #

Generic GetChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

Associated Types

type Rep GetChangeset :: Type -> Type #

Read GetChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

Show GetChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

NFData GetChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

Methods

rnf :: GetChangeset -> () #

Eq GetChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

Hashable GetChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

type AWSResponse GetChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

type Rep GetChangeset Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

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

newGetChangeset Source #

Create a value of GetChangeset 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:

GetChangeset, getChangeset_datasetId - The unique identifier for the FinSpace Dataset where the Changeset is created.

GetChangeset, getChangeset_changesetId - The unique identifier of the Changeset for which to get data.

Request Lenses

getChangeset_datasetId :: Lens' GetChangeset Text Source #

The unique identifier for the FinSpace Dataset where the Changeset is created.

getChangeset_changesetId :: Lens' GetChangeset Text Source #

The unique identifier of the Changeset for which to get data.

Destructuring the Response

data GetChangesetResponse Source #

The response from a describe changeset operation

See: newGetChangesetResponse smart constructor.

Constructors

GetChangesetResponse' 

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 where the Changeset is created.

  • errorInfo :: Maybe ChangesetErrorInfo

    The structure with error messages.

  • formatParams :: Maybe (HashMap Text Text)

    Structure of the source file(s).

  • sourceParams :: Maybe (HashMap Text Text)

    Options that define the location of the data being ingested.

  • status :: Maybe IngestionStatus

    The status of Changeset creation operation.

  • updatedByChangesetId :: Maybe Text

    The unique identifier of the updated Changeset.

  • updatesChangesetId :: Maybe Text

    The unique identifier of the Changeset that is being updated.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetChangesetResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

Associated Types

type Rep GetChangesetResponse :: Type -> Type #

Read GetChangesetResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

Show GetChangesetResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

NFData GetChangesetResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

Methods

rnf :: GetChangesetResponse -> () #

Eq GetChangesetResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

type Rep GetChangesetResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetChangeset

type Rep GetChangesetResponse = D1 ('MetaData "GetChangesetResponse" "Amazonka.FinSpaceData.GetChangeset" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "GetChangesetResponse'" '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)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetChangesetResponse Source #

Create a value of GetChangesetResponse 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:

GetChangesetResponse, getChangesetResponse_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.

GetChangesetResponse, getChangesetResponse_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.

GetChangesetResponse, getChangesetResponse_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.

GetChangesetResponse, getChangesetResponse_changesetArn - The ARN identifier of the Changeset.

GetChangeset, getChangesetResponse_changesetId - The unique identifier for a Changeset.

GetChangesetResponse, getChangesetResponse_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.

GetChangeset, getChangesetResponse_datasetId - The unique identifier for the FinSpace Dataset where the Changeset is created.

GetChangesetResponse, getChangesetResponse_errorInfo - The structure with error messages.

GetChangesetResponse, getChangesetResponse_formatParams - Structure of the source file(s).

GetChangesetResponse, getChangesetResponse_sourceParams - Options that define the location of the data being ingested.

GetChangesetResponse, getChangesetResponse_status - The status of Changeset creation operation.

GetChangesetResponse, getChangesetResponse_updatedByChangesetId - The unique identifier of the updated Changeset.

GetChangesetResponse, getChangesetResponse_updatesChangesetId - The unique identifier of the Changeset that is being updated.

$sel:httpStatus:GetChangesetResponse', getChangesetResponse_httpStatus - The response's http status code.

Response Lenses

getChangesetResponse_activeFromTimestamp :: Lens' GetChangesetResponse (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.

getChangesetResponse_activeUntilTimestamp :: Lens' GetChangesetResponse (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.

getChangesetResponse_changeType :: Lens' GetChangesetResponse (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.

getChangesetResponse_changesetId :: Lens' GetChangesetResponse (Maybe Text) Source #

The unique identifier for a Changeset.

getChangesetResponse_createTime :: Lens' GetChangesetResponse (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.

getChangesetResponse_datasetId :: Lens' GetChangesetResponse (Maybe Text) Source #

The unique identifier for the FinSpace Dataset where the Changeset is created.

getChangesetResponse_sourceParams :: Lens' GetChangesetResponse (Maybe (HashMap Text Text)) Source #

Options that define the location of the data being ingested.

getChangesetResponse_status :: Lens' GetChangesetResponse (Maybe IngestionStatus) Source #

The status of Changeset creation operation.

getChangesetResponse_updatedByChangesetId :: Lens' GetChangesetResponse (Maybe Text) Source #

The unique identifier of the updated Changeset.

getChangesetResponse_updatesChangesetId :: Lens' GetChangesetResponse (Maybe Text) Source #

The unique identifier of the Changeset that is being updated.