Amazonka.FinSpaceData.GetDataView

Gets information about a Dataview.

Creating a Request

data GetDataView

Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.

See: newGetDataView smart constructor.

Constructors

GetDataView'

Fields

• dataViewId :: Text

  The unique identifier for the Dataview.

• datasetId :: Text

  The unique identifier for the Dataset used in the Dataview.

Instances

ToHeaders GetDataView

Defined in Amazonka.FinSpaceData.GetDataView

Methods

toHeaders :: GetDataView -> [Header]

ToPath GetDataView

Defined in Amazonka.FinSpaceData.GetDataView

Methods

toPath :: GetDataView -> ByteString

ToQuery GetDataView

Defined in Amazonka.FinSpaceData.GetDataView

Methods

toQuery :: GetDataView -> QueryString

AWSRequest GetDataView

Defined in Amazonka.FinSpaceData.GetDataView

Associated Types

type AWSResponse GetDataView

Methods

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

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

Generic GetDataView

Defined in Amazonka.FinSpaceData.GetDataView

Associated Types

type Rep GetDataView :: Type -> Type

Methods

from :: GetDataView -> Rep GetDataView x

to :: Rep GetDataView x -> GetDataView

Read GetDataView

Defined in Amazonka.FinSpaceData.GetDataView

Methods

readsPrec :: Int -> ReadS GetDataView

readList :: ReadS [GetDataView]

readPrec :: ReadPrec GetDataView

readListPrec :: ReadPrec [GetDataView]

Show GetDataView

Defined in Amazonka.FinSpaceData.GetDataView

Methods

showsPrec :: Int -> GetDataView -> ShowS

show :: GetDataView -> String

showList :: [GetDataView] -> ShowS

NFData GetDataView

Defined in Amazonka.FinSpaceData.GetDataView

Methods

rnf :: GetDataView -> ()

Eq GetDataView

Defined in Amazonka.FinSpaceData.GetDataView

Methods

(==) :: GetDataView -> GetDataView -> Bool

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

Hashable GetDataView

Defined in Amazonka.FinSpaceData.GetDataView

Methods

hashWithSalt :: Int -> GetDataView -> Int

hash :: GetDataView -> Int

type AWSResponse GetDataView

Defined in Amazonka.FinSpaceData.GetDataView

type AWSResponse GetDataView = GetDataViewResponse

type Rep GetDataView

Defined in Amazonka.FinSpaceData.GetDataView

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

newGetDataView

Arguments

:: Text

GetDataView

-> Text

GetDataView

-> GetDataView

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

GetDataView, getDataView_dataViewId - The unique identifier for the Dataview.

GetDataView, getDataView_datasetId - The unique identifier for the Dataset used in the Dataview.

Request Lenses

getDataView_dataViewId :: Lens' GetDataView Text

The unique identifier for the Dataview.

getDataView_datasetId :: Lens' GetDataView Text

The unique identifier for the Dataset used in the Dataview.

Destructuring the Response

data GetDataViewResponse

Response from retrieving a dataview, which includes details on the target database and table name

See: newGetDataViewResponse smart constructor.

Constructors

GetDataViewResponse'

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

  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

  The unique identifier for the Dataset used in the Dataview.

• destinationTypeParams :: Maybe DataViewDestinationTypeParams

  Options that define the destination type for the Dataview.

• errorInfo :: Maybe DataViewErrorInfo

  Information about an error that occurred for the Dataview.

• 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.
• httpStatus :: Int

  The response's http status code.

Instances

Generic GetDataViewResponse

Defined in Amazonka.FinSpaceData.GetDataView

Associated Types

type Rep GetDataViewResponse :: Type -> Type

Methods

from :: GetDataViewResponse -> Rep GetDataViewResponse x

to :: Rep GetDataViewResponse x -> GetDataViewResponse

Read GetDataViewResponse

Defined in Amazonka.FinSpaceData.GetDataView

Methods

readsPrec :: Int -> ReadS GetDataViewResponse

readList :: ReadS [GetDataViewResponse]

readPrec :: ReadPrec GetDataViewResponse

readListPrec :: ReadPrec [GetDataViewResponse]

Show GetDataViewResponse

Defined in Amazonka.FinSpaceData.GetDataView

Methods

showsPrec :: Int -> GetDataViewResponse -> ShowS

show :: GetDataViewResponse -> String

showList :: [GetDataViewResponse] -> ShowS

NFData GetDataViewResponse

Defined in Amazonka.FinSpaceData.GetDataView

Methods

rnf :: GetDataViewResponse -> ()

Eq GetDataViewResponse

Defined in Amazonka.FinSpaceData.GetDataView

Methods

(==) :: GetDataViewResponse -> GetDataViewResponse -> Bool

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

type Rep GetDataViewResponse

Defined in Amazonka.FinSpaceData.GetDataView

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

newGetDataViewResponse

Arguments

:: Int

$sel:httpStatus:GetDataViewResponse'

-> GetDataViewResponse

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

GetDataViewResponse, getDataViewResponse_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.

GetDataViewResponse, getDataViewResponse_autoUpdate - Flag to indicate Dataview should be updated automatically.

GetDataViewResponse, getDataViewResponse_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.

GetDataViewResponse, getDataViewResponse_dataViewArn - The ARN identifier of the Dataview.

GetDataView, getDataViewResponse_dataViewId - The unique identifier for the Dataview.

GetDataView, getDataViewResponse_datasetId - The unique identifier for the Dataset used in the Dataview.

$sel:destinationTypeParams:GetDataViewResponse', getDataViewResponse_destinationTypeParams - Options that define the destination type for the Dataview.

GetDataViewResponse, getDataViewResponse_errorInfo - Information about an error that occurred for the Dataview.

GetDataViewResponse, getDataViewResponse_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.

GetDataViewResponse, getDataViewResponse_partitionColumns - Ordered set of column names used to partition data.

GetDataViewResponse, getDataViewResponse_sortColumns - Columns to be used for sorting the data.

GetDataViewResponse, getDataViewResponse_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.

$sel:httpStatus:GetDataViewResponse', getDataViewResponse_httpStatus - The response's http status code.

Response Lenses

getDataViewResponse_asOfTimestamp :: Lens' GetDataViewResponse (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.

getDataViewResponse_autoUpdate :: Lens' GetDataViewResponse (Maybe Bool)

Flag to indicate Dataview should be updated automatically.

getDataViewResponse_createTime :: Lens' GetDataViewResponse (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.

getDataViewResponse_dataViewArn :: Lens' GetDataViewResponse (Maybe Text)

The ARN identifier of the Dataview.

getDataViewResponse_dataViewId :: Lens' GetDataViewResponse (Maybe Text)

The unique identifier for the Dataview.

getDataViewResponse_datasetId :: Lens' GetDataViewResponse (Maybe Text)

The unique identifier for the Dataset used in the Dataview.

getDataViewResponse_destinationTypeParams :: Lens' GetDataViewResponse (Maybe DataViewDestinationTypeParams)

Options that define the destination type for the Dataview.

getDataViewResponse_errorInfo :: Lens' GetDataViewResponse (Maybe DataViewErrorInfo)

Information about an error that occurred for the Dataview.

getDataViewResponse_lastModifiedTime :: Lens' GetDataViewResponse (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.

getDataViewResponse_partitionColumns :: Lens' GetDataViewResponse (Maybe [Text])

Ordered set of column names used to partition data.

getDataViewResponse_sortColumns :: Lens' GetDataViewResponse (Maybe [Text])

Columns to be used for sorting the data.

getDataViewResponse_status :: Lens' GetDataViewResponse (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.

getDataViewResponse_httpStatus :: Lens' GetDataViewResponse Int

The response's http status code.