Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns a DataSource
that includes metadata and data file information,
as well as the current status of the DataSource
.
GetDataSource
provides results in normal or verbose format. The
verbose format adds the schema description and the list of files pointed
to by the DataSource to the normal format.
- getDataSource :: Text -> GetDataSource
- data GetDataSource
- gdsVerbose :: Lens' GetDataSource (Maybe Bool)
- gdsDataSourceId :: Lens' GetDataSource Text
- getDataSourceResponse :: Int -> GetDataSourceResponse
- data GetDataSourceResponse
- gdsrsStatus :: Lens' GetDataSourceResponse (Maybe EntityStatus)
- gdsrsNumberOfFiles :: Lens' GetDataSourceResponse (Maybe Integer)
- gdsrsLastUpdatedAt :: Lens' GetDataSourceResponse (Maybe UTCTime)
- gdsrsCreatedAt :: Lens' GetDataSourceResponse (Maybe UTCTime)
- gdsrsDataSourceId :: Lens' GetDataSourceResponse (Maybe Text)
- gdsrsRDSMetadata :: Lens' GetDataSourceResponse (Maybe RDSMetadata)
- gdsrsDataSizeInBytes :: Lens' GetDataSourceResponse (Maybe Integer)
- gdsrsDataSourceSchema :: Lens' GetDataSourceResponse (Maybe Text)
- gdsrsCreatedByIAMUser :: Lens' GetDataSourceResponse (Maybe Text)
- gdsrsName :: Lens' GetDataSourceResponse (Maybe Text)
- gdsrsLogURI :: Lens' GetDataSourceResponse (Maybe Text)
- gdsrsDataLocationS3 :: Lens' GetDataSourceResponse (Maybe Text)
- gdsrsComputeStatistics :: Lens' GetDataSourceResponse (Maybe Bool)
- gdsrsMessage :: Lens' GetDataSourceResponse (Maybe Text)
- gdsrsRedshiftMetadata :: Lens' GetDataSourceResponse (Maybe RedshiftMetadata)
- gdsrsDataRearrangement :: Lens' GetDataSourceResponse (Maybe Text)
- gdsrsRoleARN :: Lens' GetDataSourceResponse (Maybe Text)
- gdsrsResponseStatus :: Lens' GetDataSourceResponse Int
Creating a Request
Creates a value of GetDataSource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetDataSource Source
See: getDataSource
smart constructor.
Request Lenses
gdsVerbose :: Lens' GetDataSource (Maybe Bool) Source
Specifies whether the GetDataSource
operation should return
DataSourceSchema
.
If true, DataSourceSchema
is returned.
If false, DataSourceSchema
is not returned.
gdsDataSourceId :: Lens' GetDataSource Text Source
The ID assigned to the DataSource
at creation.
Destructuring the Response
Creates a value of GetDataSourceResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gdsrsStatus
gdsrsNumberOfFiles
gdsrsLastUpdatedAt
gdsrsCreatedAt
gdsrsDataSourceId
gdsrsRDSMetadata
gdsrsDataSizeInBytes
gdsrsDataSourceSchema
gdsrsCreatedByIAMUser
gdsrsName
gdsrsLogURI
gdsrsDataLocationS3
gdsrsComputeStatistics
gdsrsMessage
gdsrsRedshiftMetadata
gdsrsDataRearrangement
gdsrsRoleARN
gdsrsResponseStatus
data GetDataSourceResponse Source
Represents the output of a GetDataSource operation and describes a
DataSource
.
See: getDataSourceResponse
smart constructor.
Response Lenses
gdsrsStatus :: Lens' GetDataSourceResponse (Maybe EntityStatus) Source
The current status of the DataSource
. This element can have one of the
following values:
PENDING
- Amazon Machine Language (Amazon ML) submitted a request to create aDataSource
.INPROGRESS
- The creation process is underway.FAILED
- The request to create aDataSource
did not run to completion. It is not usable.COMPLETED
- The creation process completed successfully.DELETED
- TheDataSource
is marked as deleted. It is not usable.
gdsrsNumberOfFiles :: Lens' GetDataSourceResponse (Maybe Integer) Source
The number of data files referenced by the DataSource
.
gdsrsLastUpdatedAt :: Lens' GetDataSourceResponse (Maybe UTCTime) Source
The time of the most recent edit to the DataSource
. The time is
expressed in epoch time.
gdsrsCreatedAt :: Lens' GetDataSourceResponse (Maybe UTCTime) Source
The time that the DataSource
was created. The time is expressed in
epoch time.
gdsrsDataSourceId :: Lens' GetDataSourceResponse (Maybe Text) Source
The ID assigned to the DataSource
at creation. This value should be
identical to the value of the DataSourceId
in the request.
gdsrsRDSMetadata :: Lens' GetDataSourceResponse (Maybe RDSMetadata) Source
Undocumented member.
gdsrsDataSizeInBytes :: Lens' GetDataSourceResponse (Maybe Integer) Source
The total size of observations in the data files.
gdsrsDataSourceSchema :: Lens' GetDataSourceResponse (Maybe Text) Source
The schema used by all of the data files of this DataSource
.
Note
This parameter is provided as part of the verbose format.
gdsrsCreatedByIAMUser :: Lens' GetDataSourceResponse (Maybe Text) Source
The AWS user account from which the DataSource
was created. The
account type can be either an AWS root account or an AWS Identity and
Access Management (IAM) user account.
gdsrsName :: Lens' GetDataSourceResponse (Maybe Text) Source
A user-supplied name or description of the DataSource
.
gdsrsLogURI :: Lens' GetDataSourceResponse (Maybe Text) Source
A link to the file containining logs of either create DataSource
operation.
gdsrsDataLocationS3 :: Lens' GetDataSourceResponse (Maybe Text) Source
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
gdsrsComputeStatistics :: Lens' GetDataSourceResponse (Maybe Bool) Source
The parameter is true
if statistics need to be generated from the
observation data.
gdsrsMessage :: Lens' GetDataSourceResponse (Maybe Text) Source
The description of the most recent details about creating the
DataSource
.
gdsrsRedshiftMetadata :: Lens' GetDataSourceResponse (Maybe RedshiftMetadata) Source
Undocumented member.
gdsrsDataRearrangement :: Lens' GetDataSourceResponse (Maybe Text) Source
A JSON string that captures the splitting rearrangement requirement of
the DataSource
.
gdsrsRoleARN :: Lens' GetDataSourceResponse (Maybe Text) Source
Undocumented member.
gdsrsResponseStatus :: Lens' GetDataSourceResponse Int Source
The response status code.