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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a FinSpace Dataset.

Synopsis

data UpdateDataset = UpdateDataset' {
- alias :: Maybe Text
- clientToken :: Maybe Text
- datasetDescription :: Maybe Text
- schemaDefinition :: Maybe SchemaUnion
- datasetId :: Text
- datasetTitle :: Text
- kind :: DatasetKind
}
newUpdateDataset :: Text -> Text -> DatasetKind -> UpdateDataset
updateDataset_alias :: Lens' UpdateDataset (Maybe Text)
updateDataset_clientToken :: Lens' UpdateDataset (Maybe Text)
updateDataset_datasetDescription :: Lens' UpdateDataset (Maybe Text)
updateDataset_schemaDefinition :: Lens' UpdateDataset (Maybe SchemaUnion)
updateDataset_datasetId :: Lens' UpdateDataset Text
updateDataset_datasetTitle :: Lens' UpdateDataset Text
updateDataset_kind :: Lens' UpdateDataset DatasetKind
data UpdateDatasetResponse = UpdateDatasetResponse' {
- datasetId :: Maybe Text
- httpStatus :: Int
}
newUpdateDatasetResponse :: Int -> UpdateDatasetResponse
updateDatasetResponse_datasetId :: Lens' UpdateDatasetResponse (Maybe Text)
updateDatasetResponse_httpStatus :: Lens' UpdateDatasetResponse Int

Creating a Request

data UpdateDataset Source #

The request for an UpdateDataset operation

See: newUpdateDataset smart constructor.

Constructors

UpdateDataset'

Fields

alias :: Maybe Text
The unique resource identifier for a Dataset.
clientToken :: Maybe Text
A token that ensures idempotency. This token expires in 10 minutes.
datasetDescription :: Maybe Text
A description for the Dataset.
schemaDefinition :: Maybe SchemaUnion
Definition for a schema on a tabular Dataset.
datasetId :: Text
The unique identifier for the Dataset to update.
datasetTitle :: Text
A display title for the Dataset.
kind :: DatasetKind
The format in which the Dataset data is structured.
- TABULAR – Data is structured in a tabular format.
- NON_TABULAR – Data is structured in a non-tabular format.

Instances

Instances details

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

newUpdateDataset Source #

Arguments

:: Text	`UpdateDataset`
-> Text	`UpdateDataset`
-> DatasetKind	`UpdateDataset`
-> UpdateDataset

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

UpdateDataset, updateDataset_alias - The unique resource identifier for a Dataset.

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

UpdateDataset, updateDataset_datasetDescription - A description for the Dataset.

UpdateDataset, updateDataset_schemaDefinition - Definition for a schema on a tabular Dataset.

UpdateDataset, updateDataset_datasetId - The unique identifier for the Dataset to update.

UpdateDataset, updateDataset_datasetTitle - A display title for the Dataset.

UpdateDataset, updateDataset_kind - The format in which the Dataset data is structured.

TABULAR – Data is structured in a tabular format.
NON_TABULAR – Data is structured in a non-tabular format.

Request Lenses

updateDataset_alias :: Lens' UpdateDataset (Maybe Text) Source #

The unique resource identifier for a Dataset.

updateDataset_clientToken :: Lens' UpdateDataset (Maybe Text) Source #

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

updateDataset_datasetDescription :: Lens' UpdateDataset (Maybe Text) Source #

A description for the Dataset.

updateDataset_schemaDefinition :: Lens' UpdateDataset (Maybe SchemaUnion) Source #

Definition for a schema on a tabular Dataset.

updateDataset_datasetId :: Lens' UpdateDataset Text Source #

The unique identifier for the Dataset to update.

updateDataset_datasetTitle :: Lens' UpdateDataset Text Source #

A display title for the Dataset.

updateDataset_kind :: Lens' UpdateDataset DatasetKind Source #

The format in which the Dataset data is structured.

TABULAR – Data is structured in a tabular format.
NON_TABULAR – Data is structured in a non-tabular format.

Destructuring the Response

data UpdateDatasetResponse Source #

The response from an UpdateDataset operation

See: newUpdateDatasetResponse smart constructor.

Constructors

UpdateDatasetResponse'
Fields datasetId :: Maybe Text The unique identifier for updated Dataset. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateDatasetResponse Source #

Arguments

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

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

UpdateDataset, updateDatasetResponse_datasetId - The unique identifier for updated Dataset.

$sel:httpStatus:UpdateDatasetResponse', updateDatasetResponse_httpStatus - The response's http status code.

Response Lenses

updateDatasetResponse_datasetId :: Lens' UpdateDatasetResponse (Maybe Text) Source #

The unique identifier for updated Dataset.

updateDatasetResponse_httpStatus :: Lens' UpdateDatasetResponse Int Source #

The response's http status code.