Struct rusoto_sagemaker::Filter
source · [−]Expand description
A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.
If you specify a Value
, but not an Operator
, Amazon SageMaker uses the equals operator.
In search, there are several property types:
- Metrics
-
To define a metric filter, enter a value using the form
"Metrics.<name>"
, where<name>
is a metric name. For example, the following filter searches for training jobs with an"accuracy"
metric greater than"0.9"
:{
"Name": "Metrics.accuracy",
"Operator": "GreaterThan",
"Value": "0.9"
}
- HyperParameters
-
To define a hyperparameter filter, enter a value with the form
"HyperParameters.<name>"
. Decimal hyperparameter values are treated as a decimal in a comparison if the specifiedValue
is also a decimal value. If the specifiedValue
is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a"learningrate"
hyperparameter that is less than"0.5"
:{
"Name": "HyperParameters.learningrate",
"Operator": "LessThan",
"Value": "0.5"
}
- Tags
-
To define a tag filter, enter a value with the form
Tags.<key>
.
Fields
name: String
A resource property name. For example, TrainingJobName
. For valid property names, see SearchRecord. You must specify a valid property for the resource.
operator: Option<String>
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
- Equals
-
The value of
Name
equalsValue
. - NotEquals
-
The value of
Name
doesn't equalValue
. - Exists
-
The
Name
property exists. - NotExists
-
The
Name
property does not exist. - GreaterThan
-
The value of
Name
is greater thanValue
. Not supported for text properties. - GreaterThanOrEqualTo
-
The value of
Name
is greater than or equal toValue
. Not supported for text properties. - LessThan
-
The value of
Name
is less thanValue
. Not supported for text properties. - LessThanOrEqualTo
-
The value of
Name
is less than or equal toValue
. Not supported for text properties. - In
-
The value of
Name
is one of the comma delimited strings inValue
. Only supported for text properties. - Contains
-
The value of
Name
contains the stringValue
. Only supported for text properties.A
SearchExpression
can include theContains
operator multiple times when the value ofName
is one of the following:-
Experiment.DisplayName
-
Experiment.ExperimentName
-
Experiment.Tags
-
Trial.DisplayName
-
Trial.TrialName
-
Trial.Tags
-
TrialComponent.DisplayName
-
TrialComponent.TrialComponentName
-
TrialComponent.Tags
-
TrialComponent.InputArtifacts
-
TrialComponent.OutputArtifacts
A
SearchExpression
can include only oneContains
operator for all other values ofName
. In these cases, if you include multipleContains
operators in theSearchExpression
, the result is the following error message: "'CONTAINS' operator usage limit of 1 exceeded.
" -
value: Option<String>
A value used with Name
and Operator
to determine which resources satisfy the filter's condition. For numerical properties, Value
must be an integer or floating-point decimal. For timestamp properties, Value
must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS
.
Trait Implementations
impl StructuralPartialEq for Filter
Auto Trait Implementations
impl RefUnwindSafe for Filter
impl Send for Filter
impl Sync for Filter
impl Unpin for Filter
impl UnwindSafe for Filter
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
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.
sourcefn clone_into(&self, target: &mut T)
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