Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.FinSpaceData.CreateDataView

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Dataview for a Dataset.

Synopsis

data CreateDataView = CreateDataView' {
- asOfTimestamp :: Maybe Integer
- autoUpdate :: Maybe Bool
- clientToken :: Maybe Text
- partitionColumns :: Maybe [Text]
- sortColumns :: Maybe [Text]
- datasetId :: Text
- destinationTypeParams :: DataViewDestinationTypeParams
}
newCreateDataView :: Text -> DataViewDestinationTypeParams -> CreateDataView
createDataView_asOfTimestamp :: Lens' CreateDataView (Maybe Integer)
createDataView_autoUpdate :: Lens' CreateDataView (Maybe Bool)
createDataView_clientToken :: Lens' CreateDataView (Maybe Text)
createDataView_partitionColumns :: Lens' CreateDataView (Maybe [Text])
createDataView_sortColumns :: Lens' CreateDataView (Maybe [Text])
createDataView_datasetId :: Lens' CreateDataView Text
createDataView_destinationTypeParams :: Lens' CreateDataView DataViewDestinationTypeParams
data CreateDataViewResponse = CreateDataViewResponse' {
- dataViewId :: Maybe Text
- datasetId :: Maybe Text
- httpStatus :: Int
}
newCreateDataViewResponse :: Int -> CreateDataViewResponse
createDataViewResponse_dataViewId :: Lens' CreateDataViewResponse (Maybe Text)
createDataViewResponse_datasetId :: Lens' CreateDataViewResponse (Maybe Text)
createDataViewResponse_httpStatus :: Lens' CreateDataViewResponse Int

Creating a Request

data CreateDataView Source #

Request for creating a data view.

See: newCreateDataView smart constructor.

Constructors

CreateDataView'

Fields

asOfTimestamp :: Maybe Integer
Beginning time 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.
clientToken :: Maybe Text
A token that ensures idempotency. This token expires in 10 minutes.
partitionColumns :: Maybe [Text]
Ordered set of column names used to partition data.
sortColumns :: Maybe [Text]
Columns to be used for sorting the data.
datasetId :: Text
The unique Dataset identifier that is used to create a Dataview.
destinationTypeParams :: DataViewDestinationTypeParams
Options that define the destination type for the Dataview.

Instances

Instances details

ToJSON CreateDataView Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView Methods toJSON :: CreateDataView -> Value # toEncoding :: CreateDataView -> Encoding # toJSONList :: [CreateDataView] -> Value # toEncodingList :: [CreateDataView] -> Encoding #
ToHeaders CreateDataView Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView Methods toHeaders :: CreateDataView -> [Header] #
ToPath CreateDataView Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView Methods toPath :: CreateDataView -> ByteString #
ToQuery CreateDataView Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView Methods toQuery :: CreateDataView -> QueryString #
AWSRequest CreateDataView Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView Associated Types type AWSResponse CreateDataView # Methods request :: (Service -> Service) -> CreateDataView -> Request CreateDataView # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDataView -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDataView))) #
Generic CreateDataView Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView Associated Types type Rep CreateDataView :: Type -> Type # Methods from :: CreateDataView -> Rep CreateDataView x # to :: Rep CreateDataView x -> CreateDataView #
Read CreateDataView Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView Methods readsPrec :: Int -> ReadS CreateDataView # readList :: ReadS [CreateDataView] # readPrec :: ReadPrec CreateDataView # readListPrec :: ReadPrec [CreateDataView] #
Show CreateDataView Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView Methods showsPrec :: Int -> CreateDataView -> ShowS # show :: CreateDataView -> String # showList :: [CreateDataView] -> ShowS #
NFData CreateDataView Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView Methods rnf :: CreateDataView -> () #
Eq CreateDataView Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView Methods (==) :: CreateDataView -> CreateDataView -> Bool # (/=) :: CreateDataView -> CreateDataView -> Bool #
Hashable CreateDataView Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView Methods hashWithSalt :: Int -> CreateDataView -> Int # hash :: CreateDataView -> Int #
type AWSResponse CreateDataView Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView type AWSResponse CreateDataView = CreateDataViewResponse
type Rep CreateDataView Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView type Rep CreateDataView = D1 ('MetaData "CreateDataView" "Amazonka.FinSpaceData.CreateDataView" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "CreateDataView'" '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 "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "partitionColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "sortColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "datasetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "destinationTypeParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataViewDestinationTypeParams)))))

newCreateDataView Source #

Arguments

:: Text	`CreateDataView`
-> DataViewDestinationTypeParams	`$sel:destinationTypeParams:CreateDataView'`
-> CreateDataView

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

CreateDataView, createDataView_asOfTimestamp - Beginning time 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.

CreateDataView, createDataView_autoUpdate - Flag to indicate Dataview should be updated automatically.

$sel:clientToken:CreateDataView', createDataView_clientToken - A token that ensures idempotency. This token expires in 10 minutes.

CreateDataView, createDataView_partitionColumns - Ordered set of column names used to partition data.

CreateDataView, createDataView_sortColumns - Columns to be used for sorting the data.

CreateDataView, createDataView_datasetId - The unique Dataset identifier that is used to create a Dataview.

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

Request Lenses

createDataView_asOfTimestamp :: Lens' CreateDataView (Maybe Integer) Source #

Beginning time 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.

createDataView_autoUpdate :: Lens' CreateDataView (Maybe Bool) Source #

Flag to indicate Dataview should be updated automatically.

createDataView_clientToken :: Lens' CreateDataView (Maybe Text) Source #

A token that ensures idempotency. This token expires in 10 minutes.

createDataView_partitionColumns :: Lens' CreateDataView (Maybe [Text]) Source #

Ordered set of column names used to partition data.

createDataView_sortColumns :: Lens' CreateDataView (Maybe [Text]) Source #

Columns to be used for sorting the data.

createDataView_datasetId :: Lens' CreateDataView Text Source #

The unique Dataset identifier that is used to create a Dataview.

createDataView_destinationTypeParams :: Lens' CreateDataView DataViewDestinationTypeParams Source #

Options that define the destination type for the Dataview.

Destructuring the Response

data CreateDataViewResponse Source #

Response for creating a data view.

See: newCreateDataViewResponse smart constructor.

Constructors

CreateDataViewResponse'
Fields dataViewId :: Maybe Text The unique identifier for the created Dataview. datasetId :: Maybe Text The unique identifier of the Dataset used for the Dataview. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDataViewResponse Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView Associated Types type Rep CreateDataViewResponse :: Type -> Type # Methods from :: CreateDataViewResponse -> Rep CreateDataViewResponse x # to :: Rep CreateDataViewResponse x -> CreateDataViewResponse #
Read CreateDataViewResponse Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView Methods readsPrec :: Int -> ReadS CreateDataViewResponse # readList :: ReadS [CreateDataViewResponse] # readPrec :: ReadPrec CreateDataViewResponse # readListPrec :: ReadPrec [CreateDataViewResponse] #
Show CreateDataViewResponse Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView Methods showsPrec :: Int -> CreateDataViewResponse -> ShowS # show :: CreateDataViewResponse -> String # showList :: [CreateDataViewResponse] -> ShowS #
NFData CreateDataViewResponse Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView Methods rnf :: CreateDataViewResponse -> () #
Eq CreateDataViewResponse Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView Methods (==) :: CreateDataViewResponse -> CreateDataViewResponse -> Bool # (/=) :: CreateDataViewResponse -> CreateDataViewResponse -> Bool #
type Rep CreateDataViewResponse Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataView type Rep CreateDataViewResponse = D1 ('MetaData "CreateDataViewResponse" "Amazonka.FinSpaceData.CreateDataView" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "CreateDataViewResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataViewId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "datasetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateDataViewResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDataViewResponse'`
-> CreateDataViewResponse

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

CreateDataViewResponse, createDataViewResponse_dataViewId - The unique identifier for the created Dataview.

CreateDataView, createDataViewResponse_datasetId - The unique identifier of the Dataset used for the Dataview.

$sel:httpStatus:CreateDataViewResponse', createDataViewResponse_httpStatus - The response's http status code.

Response Lenses

createDataViewResponse_dataViewId :: Lens' CreateDataViewResponse (Maybe Text) Source #

The unique identifier for the created Dataview.

createDataViewResponse_datasetId :: Lens' CreateDataViewResponse (Maybe Text) Source #

The unique identifier of the Dataset used for the Dataview.

createDataViewResponse_httpStatus :: Lens' CreateDataViewResponse Int Source #

The response's http status code.