Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.MachineLearning.CreateDataSourceFromRDS

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data CreateDataSourceFromRDS Source #

See: newCreateDataSourceFromRDS smart constructor.

Constructors

CreateDataSourceFromRDS'

Fields

computeStatistics :: Maybe Bool
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 DataSource needs to be used for MLModel training.
dataSourceName :: Maybe Text
A user-supplied name or description of the DataSource.
dataSourceId :: Text
A user-supplied ID that uniquely identifies the DataSource. Typically, an Amazon Resource Number (ARN) becomes the ID for a DataSource.
rDSData :: RDSDataSpec
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}}"
roleARN :: Text
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.

Instances

Instances details

ToJSON CreateDataSourceFromRDS Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS Methods toJSON :: CreateDataSourceFromRDS -> Value # toEncoding :: CreateDataSourceFromRDS -> Encoding # toJSONList :: [CreateDataSourceFromRDS] -> Value # toEncodingList :: [CreateDataSourceFromRDS] -> Encoding #
ToHeaders CreateDataSourceFromRDS Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS Methods toHeaders :: CreateDataSourceFromRDS -> [Header] #
ToPath CreateDataSourceFromRDS Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS Methods toPath :: CreateDataSourceFromRDS -> ByteString #
ToQuery CreateDataSourceFromRDS Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS Methods toQuery :: CreateDataSourceFromRDS -> QueryString #
AWSRequest CreateDataSourceFromRDS Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS Associated Types type AWSResponse CreateDataSourceFromRDS # Methods request :: (Service -> Service) -> CreateDataSourceFromRDS -> Request CreateDataSourceFromRDS # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDataSourceFromRDS -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDataSourceFromRDS))) #
Generic CreateDataSourceFromRDS Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS Associated Types type Rep CreateDataSourceFromRDS :: Type -> Type # Methods from :: CreateDataSourceFromRDS -> Rep CreateDataSourceFromRDS x # to :: Rep CreateDataSourceFromRDS x -> CreateDataSourceFromRDS #
Read CreateDataSourceFromRDS Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS Methods readsPrec :: Int -> ReadS CreateDataSourceFromRDS # readList :: ReadS [CreateDataSourceFromRDS] # readPrec :: ReadPrec CreateDataSourceFromRDS # readListPrec :: ReadPrec [CreateDataSourceFromRDS] #
Show CreateDataSourceFromRDS Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS Methods showsPrec :: Int -> CreateDataSourceFromRDS -> ShowS # show :: CreateDataSourceFromRDS -> String # showList :: [CreateDataSourceFromRDS] -> ShowS #
NFData CreateDataSourceFromRDS Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS Methods rnf :: CreateDataSourceFromRDS -> () #
Eq CreateDataSourceFromRDS Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS Methods (==) :: CreateDataSourceFromRDS -> CreateDataSourceFromRDS -> Bool # (/=) :: CreateDataSourceFromRDS -> CreateDataSourceFromRDS -> Bool #
Hashable CreateDataSourceFromRDS Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS Methods hashWithSalt :: Int -> CreateDataSourceFromRDS -> Int # hash :: CreateDataSourceFromRDS -> Int #
type AWSResponse CreateDataSourceFromRDS Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS type AWSResponse CreateDataSourceFromRDS = CreateDataSourceFromRDSResponse
type Rep CreateDataSourceFromRDS Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS type Rep CreateDataSourceFromRDS = D1 ('MetaData "CreateDataSourceFromRDS" "Amazonka.MachineLearning.CreateDataSourceFromRDS" "amazonka-ml-2.0-A3JLJ63WvmfHxGBBIqhdRA" 'False) (C1 ('MetaCons "CreateDataSourceFromRDS'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "computeStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "dataSourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "rDSData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RDSDataSpec) :: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateDataSourceFromRDS Source #

Arguments

:: Text	`CreateDataSourceFromRDS`
-> RDSDataSpec	`$sel:rDSData:CreateDataSourceFromRDS'`
-> Text	`CreateDataSourceFromRDS`
-> CreateDataSourceFromRDS

Create a value of CreateDataSourceFromRDS 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:

CreateDataSourceFromRDS, createDataSourceFromRDS_computeStatistics - 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 DataSource needs to be used for MLModel training.

$sel:dataSourceName:CreateDataSourceFromRDS', createDataSourceFromRDS_dataSourceName - A user-supplied name or description of the DataSource.

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

$sel:rDSData:CreateDataSourceFromRDS', createDataSourceFromRDS_rDSData - 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}}"

CreateDataSourceFromRDS, createDataSourceFromRDS_roleARN - 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.

Request Lenses

createDataSourceFromRDS_computeStatistics :: 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 DataSource needs to be used for MLModel training.

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

A user-supplied name or description of the DataSource.

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

createDataSourceFromRDS_rDSData :: 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}}"

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

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: newCreateDataSourceFromRDSResponse smart constructor.

Constructors

CreateDataSourceFromRDSResponse'
Fields dataSourceId :: Maybe Text A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the `DataSourceID` in the request. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDataSourceFromRDSResponse Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS Associated Types type Rep CreateDataSourceFromRDSResponse :: Type -> Type # Methods from :: CreateDataSourceFromRDSResponse -> Rep CreateDataSourceFromRDSResponse x # to :: Rep CreateDataSourceFromRDSResponse x -> CreateDataSourceFromRDSResponse #
Read CreateDataSourceFromRDSResponse Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS Methods readsPrec :: Int -> ReadS CreateDataSourceFromRDSResponse # readList :: ReadS [CreateDataSourceFromRDSResponse] # readPrec :: ReadPrec CreateDataSourceFromRDSResponse # readListPrec :: ReadPrec [CreateDataSourceFromRDSResponse] #
Show CreateDataSourceFromRDSResponse Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS Methods showsPrec :: Int -> CreateDataSourceFromRDSResponse -> ShowS # show :: CreateDataSourceFromRDSResponse -> String # showList :: [CreateDataSourceFromRDSResponse] -> ShowS #
NFData CreateDataSourceFromRDSResponse Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS Methods rnf :: CreateDataSourceFromRDSResponse -> () #
Eq CreateDataSourceFromRDSResponse Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS Methods (==) :: CreateDataSourceFromRDSResponse -> CreateDataSourceFromRDSResponse -> Bool # (/=) :: CreateDataSourceFromRDSResponse -> CreateDataSourceFromRDSResponse -> Bool #
type Rep CreateDataSourceFromRDSResponse Source #
Instance details Defined in Amazonka.MachineLearning.CreateDataSourceFromRDS type Rep CreateDataSourceFromRDSResponse = D1 ('MetaData "CreateDataSourceFromRDSResponse" "Amazonka.MachineLearning.CreateDataSourceFromRDS" "amazonka-ml-2.0-A3JLJ63WvmfHxGBBIqhdRA" 'False) (C1 ('MetaCons "CreateDataSourceFromRDSResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDataSourceFromRDSResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDataSourceFromRDSResponse'`
-> CreateDataSourceFromRDSResponse

Create a value of CreateDataSourceFromRDSResponse 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:

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

$sel:httpStatus:CreateDataSourceFromRDSResponse', createDataSourceFromRDSResponse_httpStatus - The response's http status code.

Response Lenses

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

createDataSourceFromRDSResponse_httpStatus :: Lens' CreateDataSourceFromRDSResponse Int Source #

The response's http status code.