Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@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)
- gdsrsComputeTime :: Lens' GetDataSourceResponse (Maybe Integer)
- gdsrsDataSourceId :: Lens' GetDataSourceResponse (Maybe Text)
- gdsrsRDSMetadata :: Lens' GetDataSourceResponse (Maybe RDSMetadata)
- gdsrsDataSizeInBytes :: Lens' GetDataSourceResponse (Maybe Integer)
- gdsrsDataSourceSchema :: Lens' GetDataSourceResponse (Maybe Text)
- gdsrsStartedAt :: Lens' GetDataSourceResponse (Maybe UTCTime)
- gdsrsFinishedAt :: Lens' GetDataSourceResponse (Maybe UTCTime)
- 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:
gdsVerbose
- Specifies whether theGetDataSource
operation should returnDataSourceSchema
. If true,DataSourceSchema
is returned. If false,DataSourceSchema
is not returned.gdsDataSourceId
- The ID assigned to theDataSource
at creation.
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
getDataSourceResponse Source #
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
- The current status of theDataSource
. This element can have one of the following values: *PENDING
- 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
- The number of data files referenced by theDataSource
.gdsrsLastUpdatedAt
- The time of the most recent edit to theDataSource
. The time is expressed in epoch time.gdsrsCreatedAt
- The time that theDataSource
was created. The time is expressed in epoch time.gdsrsComputeTime
- The approximate CPU time in milliseconds that Amazon Machine Learning spent processing theDataSource
, normalized and scaled on computation resources.ComputeTime
is only available if theDataSource
is in theCOMPLETED
state and theComputeStatistics
is set to true.gdsrsDataSourceId
- The ID assigned to theDataSource
at creation. This value should be identical to the value of theDataSourceId
in the request.gdsrsRDSMetadata
- Undocumented member.gdsrsDataSizeInBytes
- The total size of observations in the data files.gdsrsDataSourceSchema
- The schema used by all of the data files of thisDataSource
.gdsrsStartedAt
- The epoch time when Amazon Machine Learning marked theDataSource
asINPROGRESS
.StartedAt
isn't available if theDataSource
is in thePENDING
state.gdsrsFinishedAt
- The epoch time when Amazon Machine Learning marked theDataSource
asCOMPLETED
orFAILED
.FinishedAt
is only available when theDataSource
is in theCOMPLETED
orFAILED
state.gdsrsCreatedByIAMUser
- The AWS user account from which theDataSource
was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.gdsrsName
- A user-supplied name or description of theDataSource
.gdsrsLogURI
- A link to the file containing logs ofCreateDataSourceFrom*
operations.gdsrsDataLocationS3
- The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).gdsrsComputeStatistics
- The parameter istrue
if statistics need to be generated from the observation data.gdsrsMessage
- The user-supplied description of the most recent details about creating theDataSource
.gdsrsRedshiftMetadata
- Undocumented member.gdsrsDataRearrangement
- A JSON string that represents the splitting and rearrangement requirement used when thisDataSource
was created.gdsrsRoleARN
- Undocumented member.gdsrsResponseStatus
- -- | The response status code.
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 ML submitted a request to create a DataSource
. * INPROGRESS
- The creation process is underway. * FAILED
- The request to create a DataSource
did not run to completion. It is not usable. * COMPLETED
- The creation process completed successfully. * DELETED
- The DataSource
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.
gdsrsComputeTime :: Lens' GetDataSourceResponse (Maybe Integer) Source #
The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the DataSource
, normalized and scaled on computation resources. ComputeTime
is only available if the DataSource
is in the COMPLETED
state and the ComputeStatistics
is set to true.
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
.
gdsrsStartedAt :: Lens' GetDataSourceResponse (Maybe UTCTime) Source #
The epoch time when Amazon Machine Learning marked the DataSource
as INPROGRESS
. StartedAt
isn't available if the DataSource
is in the PENDING
state.
gdsrsFinishedAt :: Lens' GetDataSourceResponse (Maybe UTCTime) Source #
The epoch time when Amazon Machine Learning marked the DataSource
as COMPLETED
or FAILED
. FinishedAt
is only available when the DataSource
is in the COMPLETED
or FAILED
state.
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 containing logs of CreateDataSourceFrom*
operations.
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 user-supplied 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 represents the splitting and rearrangement requirement used when this DataSource
was created.
gdsrsRoleARN :: Lens' GetDataSourceResponse (Maybe Text) Source #
Undocumented member.
gdsrsResponseStatus :: Lens' GetDataSourceResponse Int Source #
- - | The response status code.