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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new FinSpace Dataset.

Synopsis

data CreateDataset = CreateDataset' {
- alias :: Maybe Text
- clientToken :: Maybe Text
- datasetDescription :: Maybe Text
- ownerInfo :: Maybe DatasetOwnerInfo
- schemaDefinition :: Maybe SchemaUnion
- datasetTitle :: Text
- kind :: DatasetKind
- permissionGroupParams :: PermissionGroupParams
}
newCreateDataset :: Text -> DatasetKind -> PermissionGroupParams -> CreateDataset
createDataset_alias :: Lens' CreateDataset (Maybe Text)
createDataset_clientToken :: Lens' CreateDataset (Maybe Text)
createDataset_datasetDescription :: Lens' CreateDataset (Maybe Text)
createDataset_ownerInfo :: Lens' CreateDataset (Maybe DatasetOwnerInfo)
createDataset_schemaDefinition :: Lens' CreateDataset (Maybe SchemaUnion)
createDataset_datasetTitle :: Lens' CreateDataset Text
createDataset_kind :: Lens' CreateDataset DatasetKind
createDataset_permissionGroupParams :: Lens' CreateDataset PermissionGroupParams
data CreateDatasetResponse = CreateDatasetResponse' {
- datasetId :: Maybe Text
- httpStatus :: Int
}
newCreateDatasetResponse :: Int -> CreateDatasetResponse
createDatasetResponse_datasetId :: Lens' CreateDatasetResponse (Maybe Text)
createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int

Creating a Request

data CreateDataset Source #

The request for a CreateDataset operation

See: newCreateDataset smart constructor.

Constructors

CreateDataset'

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
Description of a Dataset.
ownerInfo :: Maybe DatasetOwnerInfo
Contact information for a Dataset owner.
schemaDefinition :: Maybe SchemaUnion
Definition for a schema on a tabular Dataset.
datasetTitle :: Text
Display title for a FinSpace Dataset.
kind :: DatasetKind
The format in which Dataset data is structured.
- TABULAR – Data is structured in a tabular format.
- NON_TABULAR – Data is structured in a non-tabular format.
permissionGroupParams :: PermissionGroupParams
Permission group parameters for Dataset permissions.

Instances

Instances details

ToJSON CreateDataset Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataset Methods toJSON :: CreateDataset -> Value # toEncoding :: CreateDataset -> Encoding # toJSONList :: [CreateDataset] -> Value # toEncodingList :: [CreateDataset] -> Encoding #
ToHeaders CreateDataset Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataset Methods toHeaders :: CreateDataset -> [Header] #
ToPath CreateDataset Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataset Methods toPath :: CreateDataset -> ByteString #
ToQuery CreateDataset Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataset Methods toQuery :: CreateDataset -> QueryString #
AWSRequest CreateDataset Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataset Associated Types type AWSResponse CreateDataset # Methods request :: (Service -> Service) -> CreateDataset -> Request CreateDataset # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDataset -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDataset))) #
Generic CreateDataset Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataset Associated Types type Rep CreateDataset :: Type -> Type # Methods from :: CreateDataset -> Rep CreateDataset x # to :: Rep CreateDataset x -> CreateDataset #
Show CreateDataset Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataset Methods showsPrec :: Int -> CreateDataset -> ShowS # show :: CreateDataset -> String # showList :: [CreateDataset] -> ShowS #
NFData CreateDataset Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataset Methods rnf :: CreateDataset -> () #
Eq CreateDataset Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataset Methods (==) :: CreateDataset -> CreateDataset -> Bool # (/=) :: CreateDataset -> CreateDataset -> Bool #
Hashable CreateDataset Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataset Methods hashWithSalt :: Int -> CreateDataset -> Int # hash :: CreateDataset -> Int #
type AWSResponse CreateDataset Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataset type AWSResponse CreateDataset = CreateDatasetResponse
type Rep CreateDataset Source #
Instance details Defined in Amazonka.FinSpaceData.CreateDataset type Rep CreateDataset = D1 ('MetaData "CreateDataset" "Amazonka.FinSpaceData.CreateDataset" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "CreateDataset'" '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 "ownerInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DatasetOwnerInfo)))) :: ((S1 ('MetaSel ('Just "schemaDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SchemaUnion)) :: S1 ('MetaSel ('Just "datasetTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "kind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DatasetKind) :*: S1 ('MetaSel ('Just "permissionGroupParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PermissionGroupParams)))))

newCreateDataset Source #

Arguments

:: Text	`CreateDataset`
-> DatasetKind	`CreateDataset`
-> PermissionGroupParams	`$sel:permissionGroupParams:CreateDataset'`
-> CreateDataset

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

CreateDataset, createDataset_alias - The unique resource identifier for a Dataset.

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

CreateDataset, createDataset_datasetDescription - Description of a Dataset.

CreateDataset, createDataset_ownerInfo - Contact information for a Dataset owner.

CreateDataset, createDataset_schemaDefinition - Definition for a schema on a tabular Dataset.

CreateDataset, createDataset_datasetTitle - Display title for a FinSpace Dataset.

CreateDataset, createDataset_kind - The format in which Dataset data is structured.

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

$sel:permissionGroupParams:CreateDataset', createDataset_permissionGroupParams - Permission group parameters for Dataset permissions.

Request Lenses

createDataset_alias :: Lens' CreateDataset (Maybe Text) Source #

The unique resource identifier for a Dataset.

createDataset_clientToken :: Lens' CreateDataset (Maybe Text) Source #

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

createDataset_datasetDescription :: Lens' CreateDataset (Maybe Text) Source #

Description of a Dataset.

createDataset_ownerInfo :: Lens' CreateDataset (Maybe DatasetOwnerInfo) Source #

Contact information for a Dataset owner.

createDataset_schemaDefinition :: Lens' CreateDataset (Maybe SchemaUnion) Source #

Definition for a schema on a tabular Dataset.

createDataset_datasetTitle :: Lens' CreateDataset Text Source #

Display title for a FinSpace Dataset.

createDataset_kind :: Lens' CreateDataset DatasetKind Source #

The format in which Dataset data is structured.

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

createDataset_permissionGroupParams :: Lens' CreateDataset PermissionGroupParams Source #

Permission group parameters for Dataset permissions.

Destructuring the Response

data CreateDatasetResponse Source #

The response from a CreateDataset operation

See: newCreateDatasetResponse smart constructor.

Constructors

CreateDatasetResponse'
Fields datasetId :: Maybe Text The unique identifier for the created Dataset. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateDatasetResponse Source #

Arguments

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

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

CreateDatasetResponse, createDatasetResponse_datasetId - The unique identifier for the created Dataset.

$sel:httpStatus:CreateDatasetResponse', createDatasetResponse_httpStatus - The response's http status code.

Response Lenses

createDatasetResponse_datasetId :: Lens' CreateDatasetResponse (Maybe Text) Source #

The unique identifier for the created Dataset.

createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int Source #

The response's http status code.