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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a Dataset.

Synopsis

data GetDataset = GetDataset' {
- datasetId :: Text
}
newGetDataset :: Text -> GetDataset
getDataset_datasetId :: Lens' GetDataset Text
data GetDatasetResponse = GetDatasetResponse' {
- alias :: Maybe Text
- createTime :: Maybe Integer
- datasetArn :: Maybe Text
- datasetDescription :: Maybe Text
- datasetId :: Maybe Text
- datasetTitle :: Maybe Text
- kind :: Maybe DatasetKind
- lastModifiedTime :: Maybe Integer
- schemaDefinition :: Maybe SchemaUnion
- status :: Maybe DatasetStatus
- httpStatus :: Int
}
newGetDatasetResponse :: Int -> GetDatasetResponse
getDatasetResponse_alias :: Lens' GetDatasetResponse (Maybe Text)
getDatasetResponse_createTime :: Lens' GetDatasetResponse (Maybe Integer)
getDatasetResponse_datasetArn :: Lens' GetDatasetResponse (Maybe Text)
getDatasetResponse_datasetDescription :: Lens' GetDatasetResponse (Maybe Text)
getDatasetResponse_datasetId :: Lens' GetDatasetResponse (Maybe Text)
getDatasetResponse_datasetTitle :: Lens' GetDatasetResponse (Maybe Text)
getDatasetResponse_kind :: Lens' GetDatasetResponse (Maybe DatasetKind)
getDatasetResponse_lastModifiedTime :: Lens' GetDatasetResponse (Maybe Integer)
getDatasetResponse_schemaDefinition :: Lens' GetDatasetResponse (Maybe SchemaUnion)
getDatasetResponse_status :: Lens' GetDatasetResponse (Maybe DatasetStatus)
getDatasetResponse_httpStatus :: Lens' GetDatasetResponse Int

Creating a Request

data GetDataset Source #

Request for the GetDataset operation.

See: newGetDataset smart constructor.

Constructors

GetDataset'
Fields datasetId :: Text The unique identifier for a Dataset.

Instances

Instances details

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

newGetDataset Source #

Arguments

:: Text	`GetDataset`
-> GetDataset

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

GetDataset, getDataset_datasetId - The unique identifier for a Dataset.

Request Lenses

getDataset_datasetId :: Lens' GetDataset Text Source #

The unique identifier for a Dataset.

Destructuring the Response

data GetDatasetResponse Source #

Response for the GetDataset operation

See: newGetDatasetResponse smart constructor.

Constructors

GetDatasetResponse'

Fields

alias :: Maybe Text
The unique resource identifier for a Dataset.
createTime :: Maybe Integer
The timestamp at which the Dataset 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.
datasetArn :: Maybe Text
The ARN identifier of the Dataset.
datasetDescription :: Maybe Text
A description of the Dataset.
datasetId :: Maybe Text
The unique identifier for a Dataset.
datasetTitle :: Maybe Text
Display title for a Dataset.
kind :: Maybe 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.
lastModifiedTime :: Maybe Integer
The last time that the Dataset 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.
schemaDefinition :: Maybe SchemaUnion
Definition for a schema on a tabular Dataset.
status :: Maybe DatasetStatus
Status of the Dataset creation.
- PENDING – Dataset is pending creation.
- FAILED – Dataset creation has failed.
- SUCCESS – Dataset creation has succeeded.
- RUNNING – Dataset creation is running.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetDatasetResponse Source #
Instance details Defined in Amazonka.FinSpaceData.GetDataset Associated Types type Rep GetDatasetResponse :: Type -> Type # Methods from :: GetDatasetResponse -> Rep GetDatasetResponse x # to :: Rep GetDatasetResponse x -> GetDatasetResponse #
Read GetDatasetResponse Source #
Instance details Defined in Amazonka.FinSpaceData.GetDataset Methods readsPrec :: Int -> ReadS GetDatasetResponse # readList :: ReadS [GetDatasetResponse] # readPrec :: ReadPrec GetDatasetResponse # readListPrec :: ReadPrec [GetDatasetResponse] #
Show GetDatasetResponse Source #
Instance details Defined in Amazonka.FinSpaceData.GetDataset Methods showsPrec :: Int -> GetDatasetResponse -> ShowS # show :: GetDatasetResponse -> String # showList :: [GetDatasetResponse] -> ShowS #
NFData GetDatasetResponse Source #
Instance details Defined in Amazonka.FinSpaceData.GetDataset Methods rnf :: GetDatasetResponse -> () #
Eq GetDatasetResponse Source #
Instance details Defined in Amazonka.FinSpaceData.GetDataset Methods (==) :: GetDatasetResponse -> GetDatasetResponse -> Bool # (/=) :: GetDatasetResponse -> GetDatasetResponse -> Bool #
type Rep GetDatasetResponse Source #
Instance details Defined in Amazonka.FinSpaceData.GetDataset type Rep GetDatasetResponse = D1 ('MetaData "GetDatasetResponse" "Amazonka.FinSpaceData.GetDataset" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "GetDatasetResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "datasetDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "datasetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "datasetTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "kind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DatasetKind)) :: S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: (S1 ('MetaSel ('Just "schemaDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SchemaUnion)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DatasetStatus)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetDatasetResponse Source #

Arguments

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

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

GetDatasetResponse, getDatasetResponse_alias - The unique resource identifier for a Dataset.

GetDatasetResponse, getDatasetResponse_createTime - The timestamp at which the Dataset 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.

GetDatasetResponse, getDatasetResponse_datasetArn - The ARN identifier of the Dataset.

GetDatasetResponse, getDatasetResponse_datasetDescription - A description of the Dataset.

GetDataset, getDatasetResponse_datasetId - The unique identifier for a Dataset.

GetDatasetResponse, getDatasetResponse_datasetTitle - Display title for a Dataset.

GetDatasetResponse, getDatasetResponse_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.

GetDatasetResponse, getDatasetResponse_lastModifiedTime - The last time that the Dataset 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.

GetDatasetResponse, getDatasetResponse_schemaDefinition - Definition for a schema on a tabular Dataset.

GetDatasetResponse, getDatasetResponse_status - Status of the Dataset creation.

PENDING – Dataset is pending creation.
FAILED – Dataset creation has failed.
SUCCESS – Dataset creation has succeeded.
RUNNING – Dataset creation is running.

$sel:httpStatus:GetDatasetResponse', getDatasetResponse_httpStatus - The response's http status code.

Response Lenses

getDatasetResponse_alias :: Lens' GetDatasetResponse (Maybe Text) Source #

The unique resource identifier for a Dataset.

getDatasetResponse_createTime :: Lens' GetDatasetResponse (Maybe Integer) Source #

The timestamp at which the Dataset 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.

getDatasetResponse_datasetArn :: Lens' GetDatasetResponse (Maybe Text) Source #

The ARN identifier of the Dataset.

getDatasetResponse_datasetDescription :: Lens' GetDatasetResponse (Maybe Text) Source #

A description of the Dataset.

getDatasetResponse_datasetId :: Lens' GetDatasetResponse (Maybe Text) Source #

The unique identifier for a Dataset.

getDatasetResponse_datasetTitle :: Lens' GetDatasetResponse (Maybe Text) Source #

Display title for a Dataset.

getDatasetResponse_kind :: Lens' GetDatasetResponse (Maybe 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.

getDatasetResponse_lastModifiedTime :: Lens' GetDatasetResponse (Maybe Integer) Source #

The last time that the Dataset 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.

getDatasetResponse_schemaDefinition :: Lens' GetDatasetResponse (Maybe SchemaUnion) Source #

Definition for a schema on a tabular Dataset.

getDatasetResponse_status :: Lens' GetDatasetResponse (Maybe DatasetStatus) Source #

Status of the Dataset creation.

PENDING – Dataset is pending creation.
FAILED – Dataset creation has failed.
SUCCESS – Dataset creation has succeeded.
RUNNING – Dataset creation is running.

getDatasetResponse_httpStatus :: Lens' GetDatasetResponse Int Source #

The response's http status code.