com.amazonaws.services.machinelearning.model

Class CreateDataSourceFromRDSRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.machinelearning.model.CreateDataSourceFromRDSRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateDataSourceFromRDSRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateDataSourceFromRDS operation.

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 COMPLETED or PENDING status can only be used 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.

See Also:

AmazonMachineLearning.createDataSourceFromRDS(CreateDataSourceFromRDSRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDataSourceFromRDSRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreateDataSourceFromRDSRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Boolean	getComputeStatistics() The compute statistics for a DataSource.
String	getDataSourceId() A user-supplied ID that uniquely identifies the DataSource.
String	getDataSourceName() A user-supplied name or description of the DataSource.
RDSDataSpec	getRDSData() The data specification of an Amazon RDS DataSource:
String	getRoleARN() 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.
int	hashCode()
Boolean	isComputeStatistics() The compute statistics for a DataSource.
void	setComputeStatistics(Boolean computeStatistics) The compute statistics for a DataSource.
void	setDataSourceId(String dataSourceId) A user-supplied ID that uniquely identifies the DataSource.
void	setDataSourceName(String dataSourceName) A user-supplied name or description of the DataSource.
void	setRDSData(RDSDataSpec rDSData) The data specification of an Amazon RDS DataSource:
void	setRoleARN(String 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.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateDataSourceFromRDSRequest	withComputeStatistics(Boolean computeStatistics) The compute statistics for a DataSource.
CreateDataSourceFromRDSRequest	withDataSourceId(String dataSourceId) A user-supplied ID that uniquely identifies the DataSource.
CreateDataSourceFromRDSRequest	withDataSourceName(String dataSourceName) A user-supplied name or description of the DataSource.
CreateDataSourceFromRDSRequest	withRDSData(RDSDataSpec rDSData) The data specification of an Amazon RDS DataSource:
CreateDataSourceFromRDSRequest	withRoleARN(String 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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDataSourceFromRDSRequest

public CreateDataSourceFromRDSRequest()

Method Detail

getDataSourceId

public String getDataSourceId()

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

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+

Returns:

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

setDataSourceId

public void setDataSourceId(String dataSourceId)

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

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+

Parameters:

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

withDataSourceId

public CreateDataSourceFromRDSRequest withDataSourceId(String dataSourceId)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getDataSourceName

public String getDataSourceName()

A user-supplied name or description of the DataSource.

Constraints:
Length: 0 - 1024
Pattern: .*\S.*|^$

Returns:

A user-supplied name or description of the DataSource.

setDataSourceName

public void setDataSourceName(String dataSourceName)

A user-supplied name or description of the DataSource.

Constraints:
Length: 0 - 1024
Pattern: .*\S.*|^$

Parameters:

dataSourceName - A user-supplied name or description of the DataSource.

withDataSourceName

public CreateDataSourceFromRDSRequest withDataSourceName(String dataSourceName)

A user-supplied name or description of the DataSource.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 1024
Pattern: .*\S.*|^$

Parameters:

dataSourceName - A user-supplied name or description of the DataSource.

Returns:

A reference to this updated object so that method calls can be chained together.

getRDSData

public RDSDataSpec getRDSData()

The data specification of an Amazon RDS DataSource:

• DatabaseInformation -

  • DatabaseName - Name of the Amazon RDS database.
  • InstanceIdentifier - 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 - Role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (EC2) instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

• ServiceRole - Role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon Simple Storage Service (S3). For more information, see Role templates for data pipelines.

• SecurityInfo - Security information to use to access an Amazon RDS 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 Amazon RDS instance.

• SelectSqlQuery - Query that is used to retrieve the observation data for the Datasource.

• S3StagingLocation - Amazon S3 location for staging RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

• DataSchemaUri - 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 representing the splitting requirement of a Datasource.
  

  Sample - "{\"randomSeed\":\"some-random-seed\", \"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

Returns:

The data specification of an Amazon RDS DataSource:

• DatabaseInformation -

  • DatabaseName - Name of the Amazon RDS database.
  • InstanceIdentifier - 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 - Role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (EC2) instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

• ServiceRole - Role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon Simple Storage Service (S3). For more information, see Role templates for data pipelines.

• SecurityInfo - Security information to use to access an Amazon RDS 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 Amazon RDS instance.

• SelectSqlQuery - Query that is used to retrieve the observation data for the Datasource.

• S3StagingLocation - Amazon S3 location for staging RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

• DataSchemaUri - 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 representing the splitting requirement of a Datasource.
  

  Sample - "{\"randomSeed\":\"some-random-seed\", \"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

setRDSData

public void setRDSData(RDSDataSpec rDSData)

The data specification of an Amazon RDS DataSource:

• DatabaseInformation -

  • DatabaseName - Name of the Amazon RDS database.
  • InstanceIdentifier - 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 - Role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (EC2) instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

• ServiceRole - Role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon Simple Storage Service (S3). For more information, see Role templates for data pipelines.

• SecurityInfo - Security information to use to access an Amazon RDS 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 Amazon RDS instance.

• SelectSqlQuery - Query that is used to retrieve the observation data for the Datasource.

• S3StagingLocation - Amazon S3 location for staging RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

• DataSchemaUri - 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 representing the splitting requirement of a Datasource.
  

  Sample - "{\"randomSeed\":\"some-random-seed\", \"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

Parameters:

rDSData - The data specification of an Amazon RDS DataSource:

• DatabaseInformation -

  • DatabaseName - Name of the Amazon RDS database.
  • InstanceIdentifier - 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 - Role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (EC2) instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

• ServiceRole - Role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon Simple Storage Service (S3). For more information, see Role templates for data pipelines.

• SecurityInfo - Security information to use to access an Amazon RDS 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 Amazon RDS instance.

• SelectSqlQuery - Query that is used to retrieve the observation data for the Datasource.

• S3StagingLocation - Amazon S3 location for staging RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

• DataSchemaUri - 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 representing the splitting requirement of a Datasource.
  

  Sample - "{\"randomSeed\":\"some-random-seed\", \"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

withRDSData

public CreateDataSourceFromRDSRequest withRDSData(RDSDataSpec rDSData)

The data specification of an Amazon RDS DataSource:

• DatabaseInformation -

  • DatabaseName - Name of the Amazon RDS database.
  • InstanceIdentifier - 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 - Role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (EC2) instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

• ServiceRole - Role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon Simple Storage Service (S3). For more information, see Role templates for data pipelines.

• SecurityInfo - Security information to use to access an Amazon RDS 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 Amazon RDS instance.

• SelectSqlQuery - Query that is used to retrieve the observation data for the Datasource.

• S3StagingLocation - Amazon S3 location for staging RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

• DataSchemaUri - 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 representing the splitting requirement of a Datasource.
  

  Sample - "{\"randomSeed\":\"some-random-seed\", \"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

Returns a reference to this object so that method calls can be chained together.

Parameters:

rDSData - The data specification of an Amazon RDS DataSource:

• DatabaseInformation -

  • DatabaseName - Name of the Amazon RDS database.
  • InstanceIdentifier - 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 - Role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (EC2) instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

• ServiceRole - Role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon Simple Storage Service (S3). For more information, see Role templates for data pipelines.

• SecurityInfo - Security information to use to access an Amazon RDS 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 Amazon RDS instance.

• SelectSqlQuery - Query that is used to retrieve the observation data for the Datasource.

• S3StagingLocation - Amazon S3 location for staging RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

• DataSchemaUri - 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 representing the splitting requirement of a Datasource.
  

  Sample - "{\"randomSeed\":\"some-random-seed\", \"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

Returns:

A reference to this updated object so that method calls can be chained together.

getRoleARN

public String getRoleARN()

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.

Constraints:
Length: 1 - 100

Returns:

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.

setRoleARN

public void setRoleARN(String 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.

Constraints:
Length: 1 - 100

Parameters:

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.

withRoleARN

public CreateDataSourceFromRDSRequest withRoleARN(String 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

isComputeStatistics

public Boolean isComputeStatistics()

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 an MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

Returns:

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 an MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

setComputeStatistics

public void setComputeStatistics(Boolean 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 an MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

Parameters:

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 an MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

withComputeStatistics

public CreateDataSourceFromRDSRequest withComputeStatistics(Boolean 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 an MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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 an MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

Returns:

A reference to this updated object so that method calls can be chained together.

getComputeStatistics

public Boolean getComputeStatistics()

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 an MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

Returns:

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 an MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public CreateDataSourceFromRDSRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()