Class: Aws::Comprehend::Types::CreateFlywheelRequest

Inherits:

Struct

• Object
• Struct
• Aws::Comprehend::Types::CreateFlywheelRequest

Defined in:

gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #active_model_arn ⇒ String

  To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version.

• #client_request_token ⇒ String

  A unique identifier for the request.

• #data_access_role_arn ⇒ 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.

• #data_lake_s3_uri ⇒ String

  Enter the S3 location for the data lake.

• #data_security_config ⇒ Types::DataSecurityConfig

  Data security configurations.

• #flywheel_name ⇒ String

  Name for the flywheel.

• #model_type ⇒ String

  The model type.

• #tags ⇒ Array<Types::Tag>

  The tags to associate with this flywheel.

• #task_config ⇒ Types::TaskConfig

  Configuration about the model associated with the flywheel.

Instance Attribute Details

#active_model_arn ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1408

class CreateFlywheelRequest < Struct.new(
  :flywheel_name,
  :active_model_arn,
  :data_access_role_arn,
  :task_config,
  :model_type,
  :data_lake_s3_uri,
  :data_security_config,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_token ⇒ String

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

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1408

class CreateFlywheelRequest < Struct.new(
  :flywheel_name,
  :active_model_arn,
  :data_access_role_arn,
  :task_config,
  :model_type,
  :data_lake_s3_uri,
  :data_security_config,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#data_access_role_arn ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1408

class CreateFlywheelRequest < Struct.new(
  :flywheel_name,
  :active_model_arn,
  :data_access_role_arn,
  :task_config,
  :model_type,
  :data_lake_s3_uri,
  :data_security_config,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#data_lake_s3_uri ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1408

class CreateFlywheelRequest < Struct.new(
  :flywheel_name,
  :active_model_arn,
  :data_access_role_arn,
  :task_config,
  :model_type,
  :data_lake_s3_uri,
  :data_security_config,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#data_security_config ⇒ Types::DataSecurityConfig

Data security configurations.

Returns:

• (Types::DataSecurityConfig)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1408

class CreateFlywheelRequest < Struct.new(
  :flywheel_name,
  :active_model_arn,
  :data_access_role_arn,
  :task_config,
  :model_type,
  :data_lake_s3_uri,
  :data_security_config,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#flywheel_name ⇒ String

Name for the flywheel.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1408

class CreateFlywheelRequest < Struct.new(
  :flywheel_name,
  :active_model_arn,
  :data_access_role_arn,
  :task_config,
  :model_type,
  :data_lake_s3_uri,
  :data_security_config,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#model_type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1408

class CreateFlywheelRequest < Struct.new(
  :flywheel_name,
  :active_model_arn,
  :data_access_role_arn,
  :task_config,
  :model_type,
  :data_lake_s3_uri,
  :data_security_config,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags to associate with this flywheel.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1408

class CreateFlywheelRequest < Struct.new(
  :flywheel_name,
  :active_model_arn,
  :data_access_role_arn,
  :task_config,
  :model_type,
  :data_lake_s3_uri,
  :data_security_config,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#task_config ⇒ Types::TaskConfig

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

Returns:

• (Types::TaskConfig)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1408

class CreateFlywheelRequest < Struct.new(
  :flywheel_name,
  :active_model_arn,
  :data_access_role_arn,
  :task_config,
  :model_type,
  :data_lake_s3_uri,
  :data_security_config,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end