Copyright | (c) 2013-2021 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 |
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.
Synopsis
- data GetDataSource = GetDataSource' {
- verbose :: Maybe Bool
- dataSourceId :: Text
- newGetDataSource :: Text -> GetDataSource
- getDataSource_verbose :: Lens' GetDataSource (Maybe Bool)
- getDataSource_dataSourceId :: Lens' GetDataSource Text
- data GetDataSourceResponse = GetDataSourceResponse' {
- status :: Maybe EntityStatus
- numberOfFiles :: Maybe Integer
- lastUpdatedAt :: Maybe POSIX
- createdAt :: Maybe POSIX
- computeTime :: Maybe Integer
- dataSourceId :: Maybe Text
- rDSMetadata :: Maybe RDSMetadata
- dataSizeInBytes :: Maybe Integer
- dataSourceSchema :: Maybe Text
- startedAt :: Maybe POSIX
- finishedAt :: Maybe POSIX
- createdByIamUser :: Maybe Text
- name :: Maybe Text
- logUri :: Maybe Text
- dataLocationS3 :: Maybe Text
- computeStatistics :: Maybe Bool
- message :: Maybe Text
- redshiftMetadata :: Maybe RedshiftMetadata
- dataRearrangement :: Maybe Text
- roleARN :: Maybe Text
- httpStatus :: Int
- newGetDataSourceResponse :: Int -> GetDataSourceResponse
- getDataSourceResponse_status :: Lens' GetDataSourceResponse (Maybe EntityStatus)
- getDataSourceResponse_numberOfFiles :: Lens' GetDataSourceResponse (Maybe Integer)
- getDataSourceResponse_lastUpdatedAt :: Lens' GetDataSourceResponse (Maybe UTCTime)
- getDataSourceResponse_createdAt :: Lens' GetDataSourceResponse (Maybe UTCTime)
- getDataSourceResponse_computeTime :: Lens' GetDataSourceResponse (Maybe Integer)
- getDataSourceResponse_dataSourceId :: Lens' GetDataSourceResponse (Maybe Text)
- getDataSourceResponse_rDSMetadata :: Lens' GetDataSourceResponse (Maybe RDSMetadata)
- getDataSourceResponse_dataSizeInBytes :: Lens' GetDataSourceResponse (Maybe Integer)
- getDataSourceResponse_dataSourceSchema :: Lens' GetDataSourceResponse (Maybe Text)
- getDataSourceResponse_startedAt :: Lens' GetDataSourceResponse (Maybe UTCTime)
- getDataSourceResponse_finishedAt :: Lens' GetDataSourceResponse (Maybe UTCTime)
- getDataSourceResponse_createdByIamUser :: Lens' GetDataSourceResponse (Maybe Text)
- getDataSourceResponse_name :: Lens' GetDataSourceResponse (Maybe Text)
- getDataSourceResponse_logUri :: Lens' GetDataSourceResponse (Maybe Text)
- getDataSourceResponse_dataLocationS3 :: Lens' GetDataSourceResponse (Maybe Text)
- getDataSourceResponse_computeStatistics :: Lens' GetDataSourceResponse (Maybe Bool)
- getDataSourceResponse_message :: Lens' GetDataSourceResponse (Maybe Text)
- getDataSourceResponse_redshiftMetadata :: Lens' GetDataSourceResponse (Maybe RedshiftMetadata)
- getDataSourceResponse_dataRearrangement :: Lens' GetDataSourceResponse (Maybe Text)
- getDataSourceResponse_roleARN :: Lens' GetDataSourceResponse (Maybe Text)
- getDataSourceResponse_httpStatus :: Lens' GetDataSourceResponse Int
Creating a Request
data GetDataSource Source #
See: newGetDataSource
smart constructor.
GetDataSource' | |
|
Instances
Create a value of GetDataSource
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:
$sel:verbose:GetDataSource'
, getDataSource_verbose
- Specifies whether the GetDataSource
operation should return
DataSourceSchema
.
If true, DataSourceSchema
is returned.
If false, DataSourceSchema
is not returned.
$sel:dataSourceId:GetDataSource'
, getDataSource_dataSourceId
- The ID assigned to the DataSource
at creation.
Request Lenses
getDataSource_verbose :: Lens' GetDataSource (Maybe Bool) Source #
Specifies whether the GetDataSource
operation should return
DataSourceSchema
.
If true, DataSourceSchema
is returned.
If false, DataSourceSchema
is not returned.
getDataSource_dataSourceId :: Lens' GetDataSource Text Source #
The ID assigned to the DataSource
at creation.
Destructuring the Response
data GetDataSourceResponse Source #
Represents the output of a GetDataSource
operation and describes a
DataSource
.
See: newGetDataSourceResponse
smart constructor.
GetDataSourceResponse' | |
|
Instances
newGetDataSourceResponse Source #
Create a value of GetDataSourceResponse
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:
$sel:status:GetDataSourceResponse'
, getDataSourceResponse_status
- The current status of the DataSource
. 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.
$sel:numberOfFiles:GetDataSourceResponse'
, getDataSourceResponse_numberOfFiles
- The number of data files referenced by the DataSource
.
$sel:lastUpdatedAt:GetDataSourceResponse'
, getDataSourceResponse_lastUpdatedAt
- The time of the most recent edit to the DataSource
. The time is
expressed in epoch time.
$sel:createdAt:GetDataSourceResponse'
, getDataSourceResponse_createdAt
- The time that the DataSource
was created. The time is expressed in
epoch time.
$sel:computeTime:GetDataSourceResponse'
, getDataSourceResponse_computeTime
- 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.
$sel:dataSourceId:GetDataSource'
, getDataSourceResponse_dataSourceId
- The ID assigned to the DataSource
at creation. This value should be
identical to the value of the DataSourceId
in the request.
$sel:rDSMetadata:GetDataSourceResponse'
, getDataSourceResponse_rDSMetadata
- Undocumented member.
$sel:dataSizeInBytes:GetDataSourceResponse'
, getDataSourceResponse_dataSizeInBytes
- The total size of observations in the data files.
$sel:dataSourceSchema:GetDataSourceResponse'
, getDataSourceResponse_dataSourceSchema
- The schema used by all of the data files of this DataSource
.
Note: This parameter is provided as part of the verbose format.
$sel:startedAt:GetDataSourceResponse'
, getDataSourceResponse_startedAt
- The epoch time when Amazon Machine Learning marked the DataSource
as
INPROGRESS
. StartedAt
isn't available if the DataSource
is in the
PENDING
state.
$sel:finishedAt:GetDataSourceResponse'
, getDataSourceResponse_finishedAt
- 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.
$sel:createdByIamUser:GetDataSourceResponse'
, getDataSourceResponse_createdByIamUser
- 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.
$sel:name:GetDataSourceResponse'
, getDataSourceResponse_name
- A user-supplied name or description of the DataSource
.
$sel:logUri:GetDataSourceResponse'
, getDataSourceResponse_logUri
- A link to the file containing logs of CreateDataSourceFrom*
operations.
$sel:dataLocationS3:GetDataSourceResponse'
, getDataSourceResponse_dataLocationS3
- The location of the data file or directory in Amazon Simple Storage
Service (Amazon S3).
$sel:computeStatistics:GetDataSourceResponse'
, getDataSourceResponse_computeStatistics
- The parameter is true
if statistics need to be generated from the
observation data.
$sel:message:GetDataSourceResponse'
, getDataSourceResponse_message
- The user-supplied description of the most recent details about creating
the DataSource
.
$sel:redshiftMetadata:GetDataSourceResponse'
, getDataSourceResponse_redshiftMetadata
- Undocumented member.
$sel:dataRearrangement:GetDataSourceResponse'
, getDataSourceResponse_dataRearrangement
- A JSON string that represents the splitting and rearrangement
requirement used when this DataSource
was created.
$sel:roleARN:GetDataSourceResponse'
, getDataSourceResponse_roleARN
- Undocumented member.
$sel:httpStatus:GetDataSourceResponse'
, getDataSourceResponse_httpStatus
- The response's http status code.
Response Lenses
getDataSourceResponse_status :: 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 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.
getDataSourceResponse_numberOfFiles :: Lens' GetDataSourceResponse (Maybe Integer) Source #
The number of data files referenced by the DataSource
.
getDataSourceResponse_lastUpdatedAt :: Lens' GetDataSourceResponse (Maybe UTCTime) Source #
The time of the most recent edit to the DataSource
. The time is
expressed in epoch time.
getDataSourceResponse_createdAt :: Lens' GetDataSourceResponse (Maybe UTCTime) Source #
The time that the DataSource
was created. The time is expressed in
epoch time.
getDataSourceResponse_computeTime :: 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.
getDataSourceResponse_dataSourceId :: 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.
getDataSourceResponse_rDSMetadata :: Lens' GetDataSourceResponse (Maybe RDSMetadata) Source #
Undocumented member.
getDataSourceResponse_dataSizeInBytes :: Lens' GetDataSourceResponse (Maybe Integer) Source #
The total size of observations in the data files.
getDataSourceResponse_dataSourceSchema :: 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.
getDataSourceResponse_startedAt :: 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.
getDataSourceResponse_finishedAt :: 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.
getDataSourceResponse_createdByIamUser :: 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.
getDataSourceResponse_name :: Lens' GetDataSourceResponse (Maybe Text) Source #
A user-supplied name or description of the DataSource
.
getDataSourceResponse_logUri :: Lens' GetDataSourceResponse (Maybe Text) Source #
A link to the file containing logs of CreateDataSourceFrom*
operations.
getDataSourceResponse_dataLocationS3 :: Lens' GetDataSourceResponse (Maybe Text) Source #
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
getDataSourceResponse_computeStatistics :: Lens' GetDataSourceResponse (Maybe Bool) Source #
The parameter is true
if statistics need to be generated from the
observation data.
getDataSourceResponse_message :: Lens' GetDataSourceResponse (Maybe Text) Source #
The user-supplied description of the most recent details about creating
the DataSource
.
getDataSourceResponse_redshiftMetadata :: Lens' GetDataSourceResponse (Maybe RedshiftMetadata) Source #
Undocumented member.
getDataSourceResponse_dataRearrangement :: Lens' GetDataSourceResponse (Maybe Text) Source #
A JSON string that represents the splitting and rearrangement
requirement used when this DataSource
was created.
getDataSourceResponse_roleARN :: Lens' GetDataSourceResponse (Maybe Text) Source #
Undocumented member.
getDataSourceResponse_httpStatus :: Lens' GetDataSourceResponse Int Source #
The response's http status code.