Amazonka.FinSpaceData.CreateDataset

Creates a new FinSpace Dataset.

Creating a Request

data CreateDataset

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

ToJSON CreateDataset

Defined in Amazonka.FinSpaceData.CreateDataset

Methods

toJSON :: CreateDataset -> Value

toEncoding :: CreateDataset -> Encoding

toJSONList :: [CreateDataset] -> Value

toEncodingList :: [CreateDataset] -> Encoding

ToHeaders CreateDataset

Defined in Amazonka.FinSpaceData.CreateDataset

Methods

toHeaders :: CreateDataset -> [Header]

ToPath CreateDataset

Defined in Amazonka.FinSpaceData.CreateDataset

Methods

toPath :: CreateDataset -> ByteString

ToQuery CreateDataset

Defined in Amazonka.FinSpaceData.CreateDataset

Methods

toQuery :: CreateDataset -> QueryString

AWSRequest CreateDataset

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

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

Defined in Amazonka.FinSpaceData.CreateDataset

Methods

showsPrec :: Int -> CreateDataset -> ShowS

show :: CreateDataset -> String

showList :: [CreateDataset] -> ShowS

NFData CreateDataset

Defined in Amazonka.FinSpaceData.CreateDataset

Methods

rnf :: CreateDataset -> ()

Eq CreateDataset

Defined in Amazonka.FinSpaceData.CreateDataset

Methods

(==) :: CreateDataset -> CreateDataset -> Bool

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

Hashable CreateDataset

Defined in Amazonka.FinSpaceData.CreateDataset

Methods

hashWithSalt :: Int -> CreateDataset -> Int

hash :: CreateDataset -> Int

type AWSResponse CreateDataset

Defined in Amazonka.FinSpaceData.CreateDataset

type AWSResponse CreateDataset = CreateDatasetResponse

type Rep CreateDataset

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

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)

The unique resource identifier for a Dataset.

createDataset_clientToken :: Lens' CreateDataset (Maybe Text)

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

createDataset_datasetDescription :: Lens' CreateDataset (Maybe Text)

Description of a Dataset.

createDataset_ownerInfo :: Lens' CreateDataset (Maybe DatasetOwnerInfo)

Contact information for a Dataset owner.

createDataset_schemaDefinition :: Lens' CreateDataset (Maybe SchemaUnion)

Definition for a schema on a tabular Dataset.

createDataset_datasetTitle :: Lens' CreateDataset Text

Display title for a FinSpace Dataset.

createDataset_kind :: Lens' CreateDataset 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.

createDataset_permissionGroupParams :: Lens' CreateDataset PermissionGroupParams

Permission group parameters for Dataset permissions.

Destructuring the Response

data CreateDatasetResponse

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

Generic CreateDatasetResponse

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

Defined in Amazonka.FinSpaceData.CreateDataset

Methods

readsPrec :: Int -> ReadS CreateDatasetResponse

readList :: ReadS [CreateDatasetResponse]

readPrec :: ReadPrec CreateDatasetResponse

readListPrec :: ReadPrec [CreateDatasetResponse]

Show CreateDatasetResponse

Defined in Amazonka.FinSpaceData.CreateDataset

Methods

showsPrec :: Int -> CreateDatasetResponse -> ShowS

show :: CreateDatasetResponse -> String

showList :: [CreateDatasetResponse] -> ShowS

NFData CreateDatasetResponse

Defined in Amazonka.FinSpaceData.CreateDataset

Methods

rnf :: CreateDatasetResponse -> ()

Eq CreateDatasetResponse

Defined in Amazonka.FinSpaceData.CreateDataset

Methods

(==) :: CreateDatasetResponse -> CreateDatasetResponse -> Bool

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

type Rep CreateDatasetResponse

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

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)

The unique identifier for the created Dataset.

createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int

The response's http status code.