com.amazonaws.services.machinelearning.model

Class CreateDataSourceFromRedshiftRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.machinelearning.model.CreateDataSourceFromRedshiftRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateDataSourceFromRedshiftRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateDataSourceFromRedshift operation.

Creates a DataSource from Amazon Redshift . A DataSource references data that can be used to perform either CreateMLModel, CreateEvaluation or CreateBatchPrediction operations.

CreateDataSourceFromRedshift is an asynchronous operation. In response to CreateDataSourceFromRedshift , 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.

The observations should exist in the database hosted on an Amazon Redshift cluster and should be specified by a SelectSqlQuery . Amazon ML executes Unload command in Amazon Redshift to transfer the result set of SelectSqlQuery to S3StagingLocation.

After the DataSource is created, it's ready for use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel , the DataSource requires another item -- a recipe. A recipe describes the observation variables that participate in training an MLModel . A recipe describes how each input variable will be used in training. Will the variable be included or excluded from training? Will the variable be manipulated, for example, combined with another variable or split apart into word combinations? The recipe provides answers to these questions. For more information, see the Amazon Machine Learning Developer Guide.

See Also:

AmazonMachineLearning.createDataSourceFromRedshift(CreateDataSourceFromRedshiftRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDataSourceFromRedshiftRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreateDataSourceFromRedshiftRequest	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.
RedshiftDataSpec	getDataSpec() The data specification of an Amazon Redshift DataSource:
String	getRoleARN() A fully specified role Amazon Resource Name (ARN).
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	setDataSpec(RedshiftDataSpec dataSpec) The data specification of an Amazon Redshift DataSource:
void	setRoleARN(String roleARN) A fully specified role Amazon Resource Name (ARN).
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateDataSourceFromRedshiftRequest	withComputeStatistics(Boolean computeStatistics) The compute statistics for a DataSource.
CreateDataSourceFromRedshiftRequest	withDataSourceId(String dataSourceId) A user-supplied ID that uniquely identifies the DataSource.
CreateDataSourceFromRedshiftRequest	withDataSourceName(String dataSourceName) A user-supplied name or description of the DataSource.
CreateDataSourceFromRedshiftRequest	withDataSpec(RedshiftDataSpec dataSpec) The data specification of an Amazon Redshift DataSource:
CreateDataSourceFromRedshiftRequest	withRoleARN(String roleARN) A fully specified role Amazon Resource Name (ARN).

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

CreateDataSourceFromRedshiftRequest

public CreateDataSourceFromRedshiftRequest()

Method Detail

getDataSourceId

public String getDataSourceId()

A user-supplied ID that uniquely identifies the DataSource.

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

Returns:

A user-supplied ID that uniquely identifies the DataSource.

setDataSourceId

public void setDataSourceId(String dataSourceId)

A user-supplied ID that uniquely identifies the DataSource.

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

Parameters:

dataSourceId - A user-supplied ID that uniquely identifies the DataSource.

withDataSourceId

public CreateDataSourceFromRedshiftRequest withDataSourceId(String dataSourceId)

A user-supplied ID that uniquely identifies the 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.

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

getDataSpec

public RedshiftDataSpec getDataSpec()

The data specification of an Amazon Redshift DataSource:

• DatabaseInformation -

  • DatabaseName - Name of the Amazon Redshift database.
  • ClusterIdentifier - Unique ID for the Amazon Redshift cluster.

• DatabaseCredentials - AWS Identity abd Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.

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

• S3StagingLocation - Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Relational Database Service (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 Redshift DataSource:

• DatabaseInformation -

  • DatabaseName - Name of the Amazon Redshift database.
  • ClusterIdentifier - Unique ID for the Amazon Redshift cluster.

• DatabaseCredentials - AWS Identity abd Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.

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

• S3StagingLocation - Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Relational Database Service (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}}"

setDataSpec

public void setDataSpec(RedshiftDataSpec dataSpec)

The data specification of an Amazon Redshift DataSource:

• DatabaseInformation -

  • DatabaseName - Name of the Amazon Redshift database.
  • ClusterIdentifier - Unique ID for the Amazon Redshift cluster.

• DatabaseCredentials - AWS Identity abd Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.

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

• S3StagingLocation - Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Relational Database Service (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:

dataSpec - The data specification of an Amazon Redshift DataSource:

• DatabaseInformation -

  • DatabaseName - Name of the Amazon Redshift database.
  • ClusterIdentifier - Unique ID for the Amazon Redshift cluster.

• DatabaseCredentials - AWS Identity abd Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.

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

• S3StagingLocation - Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Relational Database Service (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}}"

withDataSpec

public CreateDataSourceFromRedshiftRequest withDataSpec(RedshiftDataSpec dataSpec)

The data specification of an Amazon Redshift DataSource:

• DatabaseInformation -

  • DatabaseName - Name of the Amazon Redshift database.
  • ClusterIdentifier - Unique ID for the Amazon Redshift cluster.

• DatabaseCredentials - AWS Identity abd Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.

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

• S3StagingLocation - Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Relational Database Service (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:

dataSpec - The data specification of an Amazon Redshift DataSource:

• DatabaseInformation -

  • DatabaseName - Name of the Amazon Redshift database.
  • ClusterIdentifier - Unique ID for the Amazon Redshift cluster.

• DatabaseCredentials - AWS Identity abd Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.

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

• S3StagingLocation - Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Relational Database Service (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()

A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:

• A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster

• An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation

Constraints:
Length: 1 - 100

Returns:

A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:

• A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster

• An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation

setRoleARN

public void setRoleARN(String roleARN)

A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:

• A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster

• An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation

Constraints:
Length: 1 - 100

Parameters:

roleARN - A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:

• A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster

• An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation

withRoleARN

public CreateDataSourceFromRedshiftRequest withRoleARN(String roleARN)

A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:

• A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster

• An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation

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

Constraints:
Length: 1 - 100

Parameters:

roleARN - A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:

• A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster

• An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation

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

withComputeStatistics

public CreateDataSourceFromRedshiftRequest 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 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 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 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 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 CreateDataSourceFromRedshiftRequest 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()