Struct aws_sdk_comprehend::operation::create_flywheel::builders::CreateFlywheelFluentBuilder

pub struct CreateFlywheelFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateFlywheel.

A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model.

When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model.

To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake.

To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel.

For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Implementations

impl CreateFlywheelFluentBuilder

pub fn as_input(&self) -> &CreateFlywheelInputBuilder

Access the CreateFlywheel as a reference.

pub async fn send( self ) -> Result<CreateFlywheelOutput, SdkError<CreateFlywheelError, HttpResponse>>

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.

pub fn customize( self ) -> CustomizableOperation<CreateFlywheelOutput, CreateFlywheelError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn flywheel_name(self, input: impl Into<String>) -> Self

Name for the flywheel.

pub fn set_flywheel_name(self, input: Option<String>) -> Self

Name for the flywheel.

pub fn get_flywheel_name(&self) -> &Option<String>

Name for the flywheel.

pub fn active_model_arn(self, input: impl Into<String>) -> Self

To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version. Do not set TaskConfig or ModelType if you specify an ActiveModelArn.

pub fn set_active_model_arn(self, input: Option<String>) -> Self

To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version. Do not set TaskConfig or ModelType if you specify an ActiveModelArn.

pub fn get_active_model_arn(&self) -> &Option<String>

To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version. Do not set TaskConfig or ModelType if you specify an ActiveModelArn.

pub fn data_access_role_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.

pub fn set_data_access_role_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.

pub fn get_data_access_role_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.

pub fn task_config(self, input: TaskConfig) -> Self

Configuration about the model associated with the flywheel. You need to set TaskConfig if you are creating a flywheel for a new model.

pub fn set_task_config(self, input: Option<TaskConfig>) -> Self

Configuration about the model associated with the flywheel. You need to set TaskConfig if you are creating a flywheel for a new model.

pub fn get_task_config(&self) -> &Option<TaskConfig>

Configuration about the model associated with the flywheel. You need to set TaskConfig if you are creating a flywheel for a new model.

pub fn model_type(self, input: ModelType) -> Self

The model type. You need to set ModelType if you are creating a flywheel for a new model.

pub fn set_model_type(self, input: Option<ModelType>) -> Self

The model type. You need to set ModelType if you are creating a flywheel for a new model.

pub fn get_model_type(&self) -> &Option<ModelType>

The model type. You need to set ModelType if you are creating a flywheel for a new model.

pub fn data_lake_s3_uri(self, input: impl Into<String>) -> Self

Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this location.

pub fn set_data_lake_s3_uri(self, input: Option<String>) -> Self

Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this location.

pub fn get_data_lake_s3_uri(&self) -> &Option<String>

Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this location.

pub fn data_security_config(self, input: DataSecurityConfig) -> Self

Data security configurations.

pub fn set_data_security_config(self, input: Option<DataSecurityConfig>) -> Self

Data security configurations.

pub fn get_data_security_config(&self) -> &Option<DataSecurityConfig>

Data security configurations.

pub fn client_request_token(self, input: impl Into<String>) -> Self

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

pub fn set_client_request_token(self, input: Option<String>) -> Self

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

pub fn get_client_request_token(&self) -> &Option<String>

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

The tags to associate with this flywheel.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

The tags to associate with this flywheel.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

The tags to associate with this flywheel.

Trait Implementations

impl Clone for CreateFlywheelFluentBuilder

fn clone(&self) -> CreateFlywheelFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateFlywheelFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.