#[non_exhaustive]pub struct MlTransform {Show 19 fields
pub transform_id: Option<String>,
pub name: Option<String>,
pub description: Option<String>,
pub status: Option<TransformStatusType>,
pub created_on: Option<DateTime>,
pub last_modified_on: Option<DateTime>,
pub input_record_tables: Option<Vec<GlueTable>>,
pub parameters: Option<TransformParameters>,
pub evaluation_metrics: Option<EvaluationMetrics>,
pub label_count: i32,
pub schema: Option<Vec<SchemaColumn>>,
pub role: Option<String>,
pub glue_version: Option<String>,
pub max_capacity: Option<f64>,
pub worker_type: Option<WorkerType>,
pub number_of_workers: Option<i32>,
pub timeout: Option<i32>,
pub max_retries: Option<i32>,
pub transform_encryption: Option<TransformEncryption>,
}
Expand description
A structure for a machine learning transform.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.transform_id: Option<String>
The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.
name: Option<String>
A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.
description: Option<String>
A user-defined, long-form description text for the machine learning transform. Descriptions are not guaranteed to be unique and can be changed at any time.
status: Option<TransformStatusType>
The current status of the machine learning transform.
created_on: Option<DateTime>
A timestamp. The time and date that this machine learning transform was created.
last_modified_on: Option<DateTime>
A timestamp. The last point in time when this machine learning transform was modified.
input_record_tables: Option<Vec<GlueTable>>
A list of Glue table definitions used by the transform.
parameters: Option<TransformParameters>
A TransformParameters
object. You can use parameters to tune (customize) the behavior of the machine learning transform by specifying what data it learns from and your preference on various tradeoffs (such as precious vs. recall, or accuracy vs. cost).
evaluation_metrics: Option<EvaluationMetrics>
An EvaluationMetrics
object. Evaluation metrics provide an estimate of the quality of your machine learning transform.
label_count: i32
A count identifier for the labeling files generated by Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.
schema: Option<Vec<SchemaColumn>>
A map of key-value pairs representing the columns and data types that this transform can run against. Has an upper bound of 100 columns.
role: Option<String>
The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
-
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.
-
This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
glue_version: Option<String>
This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
max_capacity: Option<f64>
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
MaxCapacity
is a mutually exclusive option with NumberOfWorkers
and WorkerType
.
-
If either
NumberOfWorkers
orWorkerType
is set, thenMaxCapacity
cannot be set. -
If
MaxCapacity
is set then neitherNumberOfWorkers
orWorkerType
can be set. -
If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa). -
MaxCapacity
andNumberOfWorkers
must both be at least 1.
When the WorkerType
field is set to a value other than Standard
, the MaxCapacity
field is set automatically and becomes read-only.
worker_type: Option<WorkerType>
The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard, G.1X, or G.2X.
-
For the
Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. -
For the
G.1X
worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker. -
For the
G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
MaxCapacity
is a mutually exclusive option with NumberOfWorkers
and WorkerType
.
-
If either
NumberOfWorkers
orWorkerType
is set, thenMaxCapacity
cannot be set. -
If
MaxCapacity
is set then neitherNumberOfWorkers
orWorkerType
can be set. -
If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa). -
MaxCapacity
andNumberOfWorkers
must both be at least 1.
number_of_workers: Option<i32>
The number of workers of a defined workerType
that are allocated when a task of the transform runs.
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
timeout: Option<i32>
The timeout in minutes of the machine learning transform.
max_retries: Option<i32>
The maximum number of times to retry after an MLTaskRun
of the machine learning transform fails.
transform_encryption: Option<TransformEncryption>
The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
Implementations§
Source§impl MlTransform
impl MlTransform
Sourcepub fn transform_id(&self) -> Option<&str>
pub fn transform_id(&self) -> Option<&str>
The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.
Sourcepub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A user-defined, long-form description text for the machine learning transform. Descriptions are not guaranteed to be unique and can be changed at any time.
Sourcepub fn status(&self) -> Option<&TransformStatusType>
pub fn status(&self) -> Option<&TransformStatusType>
The current status of the machine learning transform.
Sourcepub fn created_on(&self) -> Option<&DateTime>
pub fn created_on(&self) -> Option<&DateTime>
A timestamp. The time and date that this machine learning transform was created.
Sourcepub fn last_modified_on(&self) -> Option<&DateTime>
pub fn last_modified_on(&self) -> Option<&DateTime>
A timestamp. The last point in time when this machine learning transform was modified.
Sourcepub fn input_record_tables(&self) -> &[GlueTable]
pub fn input_record_tables(&self) -> &[GlueTable]
A list of Glue table definitions used by the transform.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .input_record_tables.is_none()
.
Sourcepub fn parameters(&self) -> Option<&TransformParameters>
pub fn parameters(&self) -> Option<&TransformParameters>
A TransformParameters
object. You can use parameters to tune (customize) the behavior of the machine learning transform by specifying what data it learns from and your preference on various tradeoffs (such as precious vs. recall, or accuracy vs. cost).
Sourcepub fn evaluation_metrics(&self) -> Option<&EvaluationMetrics>
pub fn evaluation_metrics(&self) -> Option<&EvaluationMetrics>
An EvaluationMetrics
object. Evaluation metrics provide an estimate of the quality of your machine learning transform.
Sourcepub fn label_count(&self) -> i32
pub fn label_count(&self) -> i32
A count identifier for the labeling files generated by Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.
Sourcepub fn schema(&self) -> &[SchemaColumn]
pub fn schema(&self) -> &[SchemaColumn]
A map of key-value pairs representing the columns and data types that this transform can run against. Has an upper bound of 100 columns.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .schema.is_none()
.
Sourcepub fn role(&self) -> Option<&str>
pub fn role(&self) -> Option<&str>
The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
-
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.
-
This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
Sourcepub fn glue_version(&self) -> Option<&str>
pub fn glue_version(&self) -> Option<&str>
This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
Sourcepub fn max_capacity(&self) -> Option<f64>
pub fn max_capacity(&self) -> Option<f64>
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
MaxCapacity
is a mutually exclusive option with NumberOfWorkers
and WorkerType
.
-
If either
NumberOfWorkers
orWorkerType
is set, thenMaxCapacity
cannot be set. -
If
MaxCapacity
is set then neitherNumberOfWorkers
orWorkerType
can be set. -
If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa). -
MaxCapacity
andNumberOfWorkers
must both be at least 1.
When the WorkerType
field is set to a value other than Standard
, the MaxCapacity
field is set automatically and becomes read-only.
Sourcepub fn worker_type(&self) -> Option<&WorkerType>
pub fn worker_type(&self) -> Option<&WorkerType>
The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard, G.1X, or G.2X.
-
For the
Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. -
For the
G.1X
worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker. -
For the
G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
MaxCapacity
is a mutually exclusive option with NumberOfWorkers
and WorkerType
.
-
If either
NumberOfWorkers
orWorkerType
is set, thenMaxCapacity
cannot be set. -
If
MaxCapacity
is set then neitherNumberOfWorkers
orWorkerType
can be set. -
If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa). -
MaxCapacity
andNumberOfWorkers
must both be at least 1.
Sourcepub fn number_of_workers(&self) -> Option<i32>
pub fn number_of_workers(&self) -> Option<i32>
The number of workers of a defined workerType
that are allocated when a task of the transform runs.
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
Sourcepub fn max_retries(&self) -> Option<i32>
pub fn max_retries(&self) -> Option<i32>
The maximum number of times to retry after an MLTaskRun
of the machine learning transform fails.
Sourcepub fn transform_encryption(&self) -> Option<&TransformEncryption>
pub fn transform_encryption(&self) -> Option<&TransformEncryption>
The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
Source§impl MlTransform
impl MlTransform
Sourcepub fn builder() -> MlTransformBuilder
pub fn builder() -> MlTransformBuilder
Creates a new builder-style object to manufacture MlTransform
.
Trait Implementations§
Source§impl Clone for MlTransform
impl Clone for MlTransform
Source§fn clone(&self) -> MlTransform
fn clone(&self) -> MlTransform
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for MlTransform
impl Debug for MlTransform
Source§impl PartialEq for MlTransform
impl PartialEq for MlTransform
impl StructuralPartialEq for MlTransform
Auto Trait Implementations§
impl Freeze for MlTransform
impl RefUnwindSafe for MlTransform
impl Send for MlTransform
impl Sync for MlTransform
impl Unpin for MlTransform
impl UnwindSafe for MlTransform
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);