amazonka-ml-1.6.1: Amazon Machine Learning SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.MachineLearning.CreateDataSourceFromRDS

Contents

Description

Creates a DataSource object from an Amazon Relational Database Service (Amazon RDS). A DataSource references data that can be used to perform CreateMLModel , CreateEvaluation , or CreateBatchPrediction operations.

CreateDataSourceFromRDS is an asynchronous operation. In response to CreateDataSourceFromRDS , Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING . After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED . DataSource in the COMPLETED or PENDING state can be used only to perform >CreateMLModel >, CreateEvaluation , or CreateBatchPrediction operations.

If Amazon ML cannot accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.

Synopsis

Creating a Request

createDataSourceFromRDS Source #

Creates a value of CreateDataSourceFromRDS with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cdsfrdsDataSourceName - A user-supplied name or description of the DataSource .
  • cdsfrdsComputeStatistics - The compute statistics for a DataSource . The statistics are generated from the observation data referenced by a DataSource . Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSourceneeds to be used for MLModel training.
  • cdsfrdsDataSourceId - A user-supplied ID that uniquely identifies the DataSource . Typically, an Amazon Resource Number (ARN) becomes the ID for a DataSource .
  • cdsfrdsRDSData - The data specification of an Amazon RDS DataSource : * DatabaseInformation - * DatabaseName - The name of the Amazon RDS database. * InstanceIdentifier - A unique identifier for the Amazon RDS database instance. * DatabaseCredentials - AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon RDS database. * ResourceRole - A role (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry out the copy task from Amazon RDS to Amazon Simple Storage Service (Amazon S3). For more information, see Role templates for data pipelines. * ServiceRole - A role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines. * SecurityInfo - The security information to use to access an RDS DB instance. You need to set up appropriate ingress rules for the security entity IDs provided to allow access to the Amazon RDS instance. Specify a [SubnetId , SecurityGroupIds ] pair for a VPC-based RDS DB instance. * SelectSqlQuery - A query that is used to retrieve the observation data for the Datasource . * S3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location. * DataSchemaUri - The Amazon S3 location of the DataSchema . * DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified. * DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource . Sample - "{"splitting":{"percentBegin":10,"percentEnd":60}}"
  • cdsfrdsRoleARN - The role that Amazon ML assumes on behalf of the user to create and activate a data pipeline in the user's account and copy data using the SelectSqlQuery query from Amazon RDS to Amazon S3.

data CreateDataSourceFromRDS Source #

See: createDataSourceFromRDS smart constructor.

Instances
Eq CreateDataSourceFromRDS Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

Data CreateDataSourceFromRDS Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateDataSourceFromRDS -> c CreateDataSourceFromRDS #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateDataSourceFromRDS #

toConstr :: CreateDataSourceFromRDS -> Constr #

dataTypeOf :: CreateDataSourceFromRDS -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateDataSourceFromRDS) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateDataSourceFromRDS) #

gmapT :: (forall b. Data b => b -> b) -> CreateDataSourceFromRDS -> CreateDataSourceFromRDS #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateDataSourceFromRDS -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateDataSourceFromRDS -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateDataSourceFromRDS -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateDataSourceFromRDS -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateDataSourceFromRDS -> m CreateDataSourceFromRDS #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDataSourceFromRDS -> m CreateDataSourceFromRDS #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDataSourceFromRDS -> m CreateDataSourceFromRDS #

Read CreateDataSourceFromRDS Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

Show CreateDataSourceFromRDS Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

Generic CreateDataSourceFromRDS Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

Associated Types

type Rep CreateDataSourceFromRDS :: Type -> Type #

Hashable CreateDataSourceFromRDS Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

ToJSON CreateDataSourceFromRDS Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

AWSRequest CreateDataSourceFromRDS Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

Associated Types

type Rs CreateDataSourceFromRDS :: Type #

ToHeaders CreateDataSourceFromRDS Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

ToPath CreateDataSourceFromRDS Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

ToQuery CreateDataSourceFromRDS Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

NFData CreateDataSourceFromRDS Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

Methods

rnf :: CreateDataSourceFromRDS -> () #

type Rep CreateDataSourceFromRDS Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

type Rep CreateDataSourceFromRDS = D1 (MetaData "CreateDataSourceFromRDS" "Network.AWS.MachineLearning.CreateDataSourceFromRDS" "amazonka-ml-1.6.1-CNBnEKh3aOlK9oNc02t7Bw" False) (C1 (MetaCons "CreateDataSourceFromRDS'" PrefixI True) ((S1 (MetaSel (Just "_cdsfrdsDataSourceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cdsfrdsComputeStatistics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_cdsfrdsDataSourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_cdsfrdsRDSData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RDSDataSpec) :*: S1 (MetaSel (Just "_cdsfrdsRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs CreateDataSourceFromRDS Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

Request Lenses

cdsfrdsDataSourceName :: Lens' CreateDataSourceFromRDS (Maybe Text) Source #

A user-supplied name or description of the DataSource .

cdsfrdsComputeStatistics :: Lens' CreateDataSourceFromRDS (Maybe Bool) Source #

The compute statistics for a DataSource . The statistics are generated from the observation data referenced by a DataSource . Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSourceneeds to be used for MLModel training.

cdsfrdsDataSourceId :: Lens' CreateDataSourceFromRDS Text Source #

A user-supplied ID that uniquely identifies the DataSource . Typically, an Amazon Resource Number (ARN) becomes the ID for a DataSource .

cdsfrdsRDSData :: Lens' CreateDataSourceFromRDS RDSDataSpec Source #

The data specification of an Amazon RDS DataSource : * DatabaseInformation - * DatabaseName - The name of the Amazon RDS database. * InstanceIdentifier - A unique identifier for the Amazon RDS database instance. * DatabaseCredentials - AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon RDS database. * ResourceRole - A role (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry out the copy task from Amazon RDS to Amazon Simple Storage Service (Amazon S3). For more information, see Role templates for data pipelines. * ServiceRole - A role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines. * SecurityInfo - The security information to use to access an RDS DB instance. You need to set up appropriate ingress rules for the security entity IDs provided to allow access to the Amazon RDS instance. Specify a [SubnetId , SecurityGroupIds ] pair for a VPC-based RDS DB instance. * SelectSqlQuery - A query that is used to retrieve the observation data for the Datasource . * S3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location. * DataSchemaUri - The Amazon S3 location of the DataSchema . * DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified. * DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource . Sample - "{"splitting":{"percentBegin":10,"percentEnd":60}}"

cdsfrdsRoleARN :: Lens' CreateDataSourceFromRDS Text Source #

The role that Amazon ML assumes on behalf of the user to create and activate a data pipeline in the user's account and copy data using the SelectSqlQuery query from Amazon RDS to Amazon S3.

Destructuring the Response

createDataSourceFromRDSResponse Source #

Creates a value of CreateDataSourceFromRDSResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CreateDataSourceFromRDSResponse Source #

Represents the output of a CreateDataSourceFromRDS operation, and is an acknowledgement that Amazon ML received the request.

The CreateDataSourceFromRDS > operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter. You can inspect the Message when Status shows up as FAILED . You can also check the progress of the copy operation by going to the DataPipeline console and looking up the pipeline using the pipelineId from the describe call.

See: createDataSourceFromRDSResponse smart constructor.

Instances
Eq CreateDataSourceFromRDSResponse Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

Data CreateDataSourceFromRDSResponse Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateDataSourceFromRDSResponse -> c CreateDataSourceFromRDSResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateDataSourceFromRDSResponse #

toConstr :: CreateDataSourceFromRDSResponse -> Constr #

dataTypeOf :: CreateDataSourceFromRDSResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateDataSourceFromRDSResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateDataSourceFromRDSResponse) #

gmapT :: (forall b. Data b => b -> b) -> CreateDataSourceFromRDSResponse -> CreateDataSourceFromRDSResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateDataSourceFromRDSResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateDataSourceFromRDSResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateDataSourceFromRDSResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateDataSourceFromRDSResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateDataSourceFromRDSResponse -> m CreateDataSourceFromRDSResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDataSourceFromRDSResponse -> m CreateDataSourceFromRDSResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDataSourceFromRDSResponse -> m CreateDataSourceFromRDSResponse #

Read CreateDataSourceFromRDSResponse Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

Show CreateDataSourceFromRDSResponse Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

Generic CreateDataSourceFromRDSResponse Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

Associated Types

type Rep CreateDataSourceFromRDSResponse :: Type -> Type #

NFData CreateDataSourceFromRDSResponse Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

type Rep CreateDataSourceFromRDSResponse Source # 
Instance details

Defined in Network.AWS.MachineLearning.CreateDataSourceFromRDS

type Rep CreateDataSourceFromRDSResponse = D1 (MetaData "CreateDataSourceFromRDSResponse" "Network.AWS.MachineLearning.CreateDataSourceFromRDS" "amazonka-ml-1.6.1-CNBnEKh3aOlK9oNc02t7Bw" False) (C1 (MetaCons "CreateDataSourceFromRDSResponse'" PrefixI True) (S1 (MetaSel (Just "_cdsfrdsrsDataSourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cdsfrdsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

cdsfrdsrsDataSourceId :: Lens' CreateDataSourceFromRDSResponse (Maybe Text) Source #

A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the DataSourceID in the request.