CreateDataSourceFromS3Request (AWS SDK For Java for OSGi 1.10.3 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.machinelearning.model.CreateDataSourceFromS3Request

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable
```
public class CreateDataSourceFromS3Request
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Container for the parameters to the CreateDataSourceFromS3 operation.
Creates a DataSource object. A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

CreateDataSourceFromS3 is an asynchronous operation. In response to CreateDataSourceFromS3 , 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 observation data used in a DataSource should be ready to use; that is, it should have a consistent structure, and missing data values should be kept to a minimum. The observation data must reside in one or more CSV files in an Amazon Simple Storage Service (Amazon S3) bucket, along with a schema that describes the data items by name and type. The same schema must be used for all of the data files referenced by the DataSource .

After the DataSource has been created, it's ready to 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.createDataSourceFromS3(CreateDataSourceFromS3Request), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateDataSourceFromS3Request()

Constructors
Constructor and Description
`CreateDataSourceFromS3Request()`

Method Summary

Methods
Modifier and Type	Method and Description
`CreateDataSourceFromS3Request`	`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 identifier that uniquely identifies the `DataSource`.
`String`	`getDataSourceName()` A user-supplied name or description of the `DataSource`.
`S3DataSpec`	`getDataSpec()` The data specification of a `DataSource`:
`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 identifier that uniquely identifies the `DataSource`.
`void`	`setDataSourceName(String dataSourceName)` A user-supplied name or description of the `DataSource`.
`void`	`setDataSpec(S3DataSpec dataSpec)` The data specification of a `DataSource`:
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateDataSourceFromS3Request`	`withComputeStatistics(Boolean computeStatistics)` The compute statistics for a `DataSource`.
`CreateDataSourceFromS3Request`	`withDataSourceId(String dataSourceId)` A user-supplied identifier that uniquely identifies the `DataSource`.
`CreateDataSourceFromS3Request`	`withDataSourceName(String dataSourceName)` A user-supplied name or description of the `DataSource`.
`CreateDataSourceFromS3Request`	`withDataSpec(S3DataSpec dataSpec)` The data specification of a `DataSource`:

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateDataSourceFromS3Request
```
public CreateDataSourceFromS3Request()
```
- Method Detail
  - getDataSourceId
```
public String getDataSourceId()
```
    A user-supplied identifier that uniquely identifies the DataSource.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    A user-supplied identifier that uniquely identifies the DataSource.
  - setDataSourceId
```
public void setDataSourceId(String dataSourceId)
```
    A user-supplied identifier that uniquely identifies the DataSource.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    dataSourceId - A user-supplied identifier that uniquely identifies the DataSource.
  - withDataSourceId
```
public CreateDataSourceFromS3Request withDataSourceId(String dataSourceId)
```
    A user-supplied identifier 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 identifier 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 CreateDataSourceFromS3Request 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 S3DataSpec getDataSpec()
```
    The data specification of a DataSource:
    - DataLocationS3 - Amazon Simple Storage Service (Amazon S3) location of the observation data.
    - DataSchemaLocationS3 - 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 a DataSource:
    
    DataLocationS3 - Amazon Simple Storage Service (Amazon S3) location of the observation data.
    
    DataSchemaLocationS3 - 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(S3DataSpec dataSpec)
```
    The data specification of a DataSource:
    - DataLocationS3 - Amazon Simple Storage Service (Amazon S3) location of the observation data.
    - DataSchemaLocationS3 - 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 a DataSource:
    
    DataLocationS3 - Amazon Simple Storage Service (Amazon S3) location of the observation data.
    
    DataSchemaLocationS3 - 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 CreateDataSourceFromS3Request withDataSpec(S3DataSpec dataSpec)
```
    The data specification of a DataSource:
    - DataLocationS3 - Amazon Simple Storage Service (Amazon S3) location of the observation data.
    - DataSchemaLocationS3 - 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 a DataSource:
    
    DataLocationS3 - Amazon Simple Storage Service (Amazon S3) location of the observation data.
    
    DataSchemaLocationS3 - 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.
  - 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 CreateDataSourceFromS3Request 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 CreateDataSourceFromS3Request 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()

Class CreateDataSourceFromS3Request

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateDataSourceFromS3Request

Method Detail

getDataSourceId

setDataSourceId

withDataSourceId

getDataSourceName

setDataSourceName

withDataSourceName

getDataSpec

setDataSpec

withDataSpec

isComputeStatistics

setComputeStatistics

withComputeStatistics

getComputeStatistics

toString

hashCode

equals

clone