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

Description

 
Synopsis

Documentation

data DataViewSummary Source #

Structure for the summary of a Dataview.

See: newDataViewSummary smart constructor.

Constructors

DataViewSummary' 

Fields

  • asOfTimestamp :: Maybe Integer

    Time range to use for the Dataview. 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.

  • autoUpdate :: Maybe Bool

    The flag to indicate Dataview should be updated automatically.

  • createTime :: Maybe Integer

    The timestamp at which the Dataview 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.

  • dataViewArn :: Maybe Text

    The ARN identifier of the Dataview.

  • dataViewId :: Maybe Text

    The unique identifier for the Dataview.

  • datasetId :: Maybe Text

    Th unique identifier for the Dataview Dataset.

  • destinationTypeProperties :: Maybe DataViewDestinationTypeParams

    Information about the Dataview destination.

  • errorInfo :: Maybe DataViewErrorInfo

    The structure with error messages.

  • lastModifiedTime :: Maybe Integer

    The last time that a Dataview was modified. 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.

  • partitionColumns :: Maybe [Text]

    Ordered set of column names used to partition data.

  • sortColumns :: Maybe [Text]

    Columns to be used for sorting the data.

  • status :: Maybe DataViewStatus

    The status of a Dataview creation.

    • RUNNING – Dataview creation is running.
    • STARTING – Dataview creation is starting.
    • FAILED – Dataview creation has failed.
    • CANCELLED – Dataview creation has been cancelled.
    • TIMEOUT – Dataview creation has timed out.
    • SUCCESS – Dataview creation has succeeded.
    • PENDING – Dataview creation is pending.
    • FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed.

Instances

Instances details
FromJSON DataViewSummary Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.DataViewSummary

Generic DataViewSummary Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.DataViewSummary

Associated Types

type Rep DataViewSummary :: Type -> Type #

Read DataViewSummary Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.DataViewSummary

Show DataViewSummary Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.DataViewSummary

NFData DataViewSummary Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.DataViewSummary

Methods

rnf :: DataViewSummary -> () #

Eq DataViewSummary Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.DataViewSummary

Hashable DataViewSummary Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.DataViewSummary

type Rep DataViewSummary Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.DataViewSummary

type Rep DataViewSummary = D1 ('MetaData "DataViewSummary" "Amazonka.FinSpaceData.Types.DataViewSummary" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "DataViewSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "asOfTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "autoUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: (S1 ('MetaSel ('Just "dataViewArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dataViewId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "datasetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "destinationTypeProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataViewDestinationTypeParams)) :*: (S1 ('MetaSel ('Just "errorInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataViewErrorInfo)) :*: S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: (S1 ('MetaSel ('Just "partitionColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "sortColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataViewStatus)))))))

newDataViewSummary :: DataViewSummary Source #

Create a value of DataViewSummary 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:asOfTimestamp:DataViewSummary', dataViewSummary_asOfTimestamp - Time range to use for the Dataview. 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:autoUpdate:DataViewSummary', dataViewSummary_autoUpdate - The flag to indicate Dataview should be updated automatically.

$sel:createTime:DataViewSummary', dataViewSummary_createTime - The timestamp at which the Dataview 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:dataViewArn:DataViewSummary', dataViewSummary_dataViewArn - The ARN identifier of the Dataview.

$sel:dataViewId:DataViewSummary', dataViewSummary_dataViewId - The unique identifier for the Dataview.

$sel:datasetId:DataViewSummary', dataViewSummary_datasetId - Th unique identifier for the Dataview Dataset.

$sel:destinationTypeProperties:DataViewSummary', dataViewSummary_destinationTypeProperties - Information about the Dataview destination.

$sel:errorInfo:DataViewSummary', dataViewSummary_errorInfo - The structure with error messages.

$sel:lastModifiedTime:DataViewSummary', dataViewSummary_lastModifiedTime - The last time that a Dataview was modified. 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:partitionColumns:DataViewSummary', dataViewSummary_partitionColumns - Ordered set of column names used to partition data.

$sel:sortColumns:DataViewSummary', dataViewSummary_sortColumns - Columns to be used for sorting the data.

$sel:status:DataViewSummary', dataViewSummary_status - The status of a Dataview creation.

  • RUNNING – Dataview creation is running.
  • STARTING – Dataview creation is starting.
  • FAILED – Dataview creation has failed.
  • CANCELLED – Dataview creation has been cancelled.
  • TIMEOUT – Dataview creation has timed out.
  • SUCCESS – Dataview creation has succeeded.
  • PENDING – Dataview creation is pending.
  • FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed.

dataViewSummary_asOfTimestamp :: Lens' DataViewSummary (Maybe Integer) Source #

Time range to use for the Dataview. 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.

dataViewSummary_autoUpdate :: Lens' DataViewSummary (Maybe Bool) Source #

The flag to indicate Dataview should be updated automatically.

dataViewSummary_createTime :: Lens' DataViewSummary (Maybe Integer) Source #

The timestamp at which the Dataview 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.

dataViewSummary_dataViewArn :: Lens' DataViewSummary (Maybe Text) Source #

The ARN identifier of the Dataview.

dataViewSummary_dataViewId :: Lens' DataViewSummary (Maybe Text) Source #

The unique identifier for the Dataview.

dataViewSummary_datasetId :: Lens' DataViewSummary (Maybe Text) Source #

Th unique identifier for the Dataview Dataset.

dataViewSummary_lastModifiedTime :: Lens' DataViewSummary (Maybe Integer) Source #

The last time that a Dataview was modified. 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.

dataViewSummary_partitionColumns :: Lens' DataViewSummary (Maybe [Text]) Source #

Ordered set of column names used to partition data.

dataViewSummary_sortColumns :: Lens' DataViewSummary (Maybe [Text]) Source #

Columns to be used for sorting the data.

dataViewSummary_status :: Lens' DataViewSummary (Maybe DataViewStatus) Source #

The status of a Dataview creation.

  • RUNNING – Dataview creation is running.
  • STARTING – Dataview creation is starting.
  • FAILED – Dataview creation has failed.
  • CANCELLED – Dataview creation has been cancelled.
  • TIMEOUT – Dataview creation has timed out.
  • SUCCESS – Dataview creation has succeeded.
  • PENDING – Dataview creation is pending.
  • FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed.