pub struct CreateDataSourceFromRedshift { /* private fields */ }Expand description
Fluent builder constructing a request to CreateDataSourceFromRedshift.
Creates a DataSource from a database hosted on an Amazon Redshift cluster. 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 states can be used to perform only CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.
If Amazon ML can't 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 be contained in the database hosted on an Amazon Redshift cluster and should be specified by a SelectSqlQuery query. Amazon ML executes an Unload command in Amazon Redshift to transfer the result set of the SelectSqlQuery query to S3StagingLocation.
After the DataSource has been created, it's ready for use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also requires a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions.
You can't change an existing datasource, but you can copy and modify the settings from an existing Amazon Redshift datasource to create a new datasource. To do so, call GetDataSource for an existing datasource and copy the values to a CreateDataSource call. Change the settings that you want to change and make sure that all required fields have the appropriate values.
Implementations
sourceimpl CreateDataSourceFromRedshift
impl CreateDataSourceFromRedshift
sourcepub async fn send(
self
) -> Result<CreateDataSourceFromRedshiftOutput, SdkError<CreateDataSourceFromRedshiftError>>
pub async fn send(
self
) -> Result<CreateDataSourceFromRedshiftOutput, SdkError<CreateDataSourceFromRedshiftError>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn data_source_id(self, input: impl Into<String>) -> Self
pub fn data_source_id(self, input: impl Into<String>) -> Self
A user-supplied ID that uniquely identifies the DataSource.
sourcepub fn set_data_source_id(self, input: Option<String>) -> Self
pub fn set_data_source_id(self, input: Option<String>) -> Self
A user-supplied ID that uniquely identifies the DataSource.
sourcepub fn data_source_name(self, input: impl Into<String>) -> Self
pub fn data_source_name(self, input: impl Into<String>) -> Self
A user-supplied name or description of the DataSource.
sourcepub fn set_data_source_name(self, input: Option<String>) -> Self
pub fn set_data_source_name(self, input: Option<String>) -> Self
A user-supplied name or description of the DataSource.
sourcepub fn data_spec(self, input: RedshiftDataSpec) -> Self
pub fn data_spec(self, input: RedshiftDataSpec) -> Self
The data specification of an Amazon Redshift DataSource:
-
DatabaseInformation -
-
DatabaseName- The name of the Amazon Redshift database. -
ClusterIdentifier- The unique ID for the Amazon Redshift cluster.
-
-
DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.
-
SelectSqlQuery - The query that is used to retrieve the observation data for the
Datasource. -
S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Redshift using the
SelectSqlQueryquery 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
DataSchemaUriis specified. -
DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the
DataSource.Sample -
"{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
sourcepub fn set_data_spec(self, input: Option<RedshiftDataSpec>) -> Self
pub fn set_data_spec(self, input: Option<RedshiftDataSpec>) -> Self
The data specification of an Amazon Redshift DataSource:
-
DatabaseInformation -
-
DatabaseName- The name of the Amazon Redshift database. -
ClusterIdentifier- The unique ID for the Amazon Redshift cluster.
-
-
DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.
-
SelectSqlQuery - The query that is used to retrieve the observation data for the
Datasource. -
S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Redshift using the
SelectSqlQueryquery 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
DataSchemaUriis specified. -
DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the
DataSource.Sample -
"{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
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
SelectSqlQueryquery on an Amazon Redshift cluster -
An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the
S3StagingLocation
sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
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
SelectSqlQueryquery on an Amazon Redshift cluster -
An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the
S3StagingLocation
sourcepub fn compute_statistics(self, input: bool) -> Self
pub fn compute_statistics(self, input: bool) -> Self
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.
sourcepub fn set_compute_statistics(self, input: Option<bool>) -> Self
pub fn set_compute_statistics(self, input: Option<bool>) -> Self
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.
Trait Implementations
sourceimpl Clone for CreateDataSourceFromRedshift
impl Clone for CreateDataSourceFromRedshift
sourcefn clone(&self) -> CreateDataSourceFromRedshift
fn clone(&self) -> CreateDataSourceFromRedshift
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
Auto Trait Implementations
impl !RefUnwindSafe for CreateDataSourceFromRedshift
impl Send for CreateDataSourceFromRedshift
impl Sync for CreateDataSourceFromRedshift
impl Unpin for CreateDataSourceFromRedshift
impl !UnwindSafe for CreateDataSourceFromRedshift
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more