amazonka-ml-2.0: Amazon Machine Learning SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MachineLearning.GetDataSource

Description

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

Creating a Request

data GetDataSource Source #

See: newGetDataSource smart constructor.

Constructors

GetDataSource' 

Fields

  • verbose :: Maybe Bool

    Specifies whether the GetDataSource operation should return DataSourceSchema.

    If true, DataSourceSchema is returned.

    If false, DataSourceSchema is not returned.

  • dataSourceId :: Text

    The ID assigned to the DataSource at creation.

Instances

Instances details
ToJSON GetDataSource Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

ToHeaders GetDataSource Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

ToPath GetDataSource Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

ToQuery GetDataSource Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

AWSRequest GetDataSource Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

Associated Types

type AWSResponse GetDataSource #

Generic GetDataSource Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

Associated Types

type Rep GetDataSource :: Type -> Type #

Read GetDataSource Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

Show GetDataSource Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

NFData GetDataSource Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

Methods

rnf :: GetDataSource -> () #

Eq GetDataSource Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

Hashable GetDataSource Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

type AWSResponse GetDataSource Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

type Rep GetDataSource Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

type Rep GetDataSource = D1 ('MetaData "GetDataSource" "Amazonka.MachineLearning.GetDataSource" "amazonka-ml-2.0-A3JLJ63WvmfHxGBBIqhdRA" 'False) (C1 ('MetaCons "GetDataSource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "verbose") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetDataSource Source #

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.

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.

Constructors

GetDataSourceResponse' 

Fields

  • computeStatistics :: Maybe Bool

    The parameter is true if statistics need to be generated from the observation data.

  • computeTime :: Maybe Integer

    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.

  • createdAt :: Maybe POSIX

    The time that the DataSource was created. The time is expressed in epoch time.

  • createdByIamUser :: Maybe Text

    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.

  • dataLocationS3 :: Maybe Text

    The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

  • dataRearrangement :: Maybe Text

    A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created.

  • dataSizeInBytes :: Maybe Integer

    The total size of observations in the data files.

  • dataSourceId :: Maybe Text

    The ID assigned to the DataSource at creation. This value should be identical to the value of the DataSourceId in the request.

  • dataSourceSchema :: Maybe Text

    The schema used by all of the data files of this DataSource.

    Note: This parameter is provided as part of the verbose format.

  • finishedAt :: Maybe POSIX

    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.

  • lastUpdatedAt :: Maybe POSIX

    The time of the most recent edit to the DataSource. The time is expressed in epoch time.

  • logUri :: Maybe Text

    A link to the file containing logs of CreateDataSourceFrom* operations.

  • message :: Maybe Text

    The user-supplied description of the most recent details about creating the DataSource.

  • name :: Maybe Text

    A user-supplied name or description of the DataSource.

  • numberOfFiles :: Maybe Integer

    The number of data files referenced by the DataSource.

  • rDSMetadata :: Maybe RDSMetadata
     
  • redshiftMetadata :: Maybe RedshiftMetadata
     
  • roleARN :: Maybe Text
     
  • startedAt :: Maybe POSIX

    The epoch time when Amazon Machine Learning marked the DataSource as INPROGRESS. StartedAt isn't available if the DataSource is in the PENDING state.

  • status :: Maybe EntityStatus

    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.
  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetDataSourceResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

Associated Types

type Rep GetDataSourceResponse :: Type -> Type #

Read GetDataSourceResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

Show GetDataSourceResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

NFData GetDataSourceResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

Methods

rnf :: GetDataSourceResponse -> () #

Eq GetDataSourceResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

type Rep GetDataSourceResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.GetDataSource

type Rep GetDataSourceResponse = D1 ('MetaData "GetDataSourceResponse" "Amazonka.MachineLearning.GetDataSource" "amazonka-ml-2.0-A3JLJ63WvmfHxGBBIqhdRA" 'False) (C1 ('MetaCons "GetDataSourceResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "computeStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "computeTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "createdByIamUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dataLocationS3") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "dataRearrangement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dataSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dataSourceSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "finishedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))) :*: (((S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "logUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "numberOfFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :*: ((S1 ('MetaSel ('Just "rDSMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RDSMetadata)) :*: (S1 ('MetaSel ('Just "redshiftMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedshiftMetadata)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

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:

GetDataSourceResponse, getDataSourceResponse_computeStatistics - The parameter is true if statistics need to be generated from the observation data.

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.

GetDataSourceResponse, getDataSourceResponse_createdAt - The time that the DataSource was created. The time is expressed in epoch time.

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.

GetDataSourceResponse, getDataSourceResponse_dataLocationS3 - The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

GetDataSourceResponse, getDataSourceResponse_dataRearrangement - A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created.

GetDataSourceResponse, getDataSourceResponse_dataSizeInBytes - The total size of observations in the data files.

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

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.

GetDataSourceResponse, getDataSourceResponse_lastUpdatedAt - The time of the most recent edit to the DataSource. The time is expressed in epoch time.

$sel:logUri:GetDataSourceResponse', getDataSourceResponse_logUri - A link to the file containing logs of CreateDataSourceFrom* operations.

GetDataSourceResponse, getDataSourceResponse_message - The user-supplied description of the most recent details about creating the DataSource.

GetDataSourceResponse, getDataSourceResponse_name - A user-supplied name or description of the DataSource.

GetDataSourceResponse, getDataSourceResponse_numberOfFiles - The number of data files referenced by the DataSource.

GetDataSourceResponse, getDataSourceResponse_rDSMetadata - Undocumented member.

GetDataSourceResponse, getDataSourceResponse_redshiftMetadata - Undocumented member.

GetDataSourceResponse, getDataSourceResponse_roleARN - Undocumented member.

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.

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

$sel:httpStatus:GetDataSourceResponse', getDataSourceResponse_httpStatus - The response's http status code.

Response Lenses

getDataSourceResponse_computeStatistics :: Lens' GetDataSourceResponse (Maybe Bool) Source #

The parameter is true if statistics need to be generated from the observation data.

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_createdAt :: Lens' GetDataSourceResponse (Maybe UTCTime) Source #

The time that the DataSource was created. The time is expressed in epoch time.

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_dataLocationS3 :: Lens' GetDataSourceResponse (Maybe Text) Source #

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

getDataSourceResponse_dataRearrangement :: Lens' GetDataSourceResponse (Maybe Text) Source #

A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created.

getDataSourceResponse_dataSizeInBytes :: Lens' GetDataSourceResponse (Maybe Integer) Source #

The total size of observations in the data files.

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_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_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_lastUpdatedAt :: Lens' GetDataSourceResponse (Maybe UTCTime) Source #

The time of the most recent edit to the DataSource. The time is expressed in epoch time.

getDataSourceResponse_logUri :: Lens' GetDataSourceResponse (Maybe Text) Source #

A link to the file containing logs of CreateDataSourceFrom* operations.

getDataSourceResponse_message :: Lens' GetDataSourceResponse (Maybe Text) Source #

The user-supplied description of the most recent details about creating the DataSource.

getDataSourceResponse_name :: Lens' GetDataSourceResponse (Maybe Text) Source #

A user-supplied name or description of the DataSource.

getDataSourceResponse_numberOfFiles :: Lens' GetDataSourceResponse (Maybe Integer) Source #

The number of data files referenced by the DataSource.

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