Struct aws_sdk_sagemaker::model::Filter [−][src]
#[non_exhaustive]pub struct Filter {
pub name: Option<String>,
pub operator: Option<Operator>,
pub value: Option<String>,
}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., where" 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.. Decimal hyperparameter values are treated as a decimal in a comparison if the specified" Valueis also a decimal value. If the specifiedValueis an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a"learning_rate"hyperparameter that is less than"0.5":{"Name": "HyperParameters.learning_rate","Operator": "LessThan","Value": "0.5"} - Tags
-
To define a tag filter, enter a value with the form
Tags..
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.name: Option<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<Operator>A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
- Equals
-
The value of
NameequalsValue. - NotEquals
-
The value of
Namedoesn't equalValue. - Exists
-
The
Nameproperty exists. - NotExists
-
The
Nameproperty does not exist. - GreaterThan
-
The value of
Nameis greater thanValue. Not supported for text properties. - GreaterThanOrEqualTo
-
The value of
Nameis greater than or equal toValue. Not supported for text properties. - LessThan
-
The value of
Nameis less thanValue. Not supported for text properties. - LessThanOrEqualTo
-
The value of
Nameis less than or equal toValue. Not supported for text properties. - In
-
The value of
Nameis one of the comma delimited strings inValue. Only supported for text properties. - Contains
-
The value of
Namecontains the stringValue. Only supported for text properties.A
SearchExpressioncan include theContainsoperator multiple times when the value ofNameis 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
SearchExpressioncan include only oneContainsoperator for all other values ofName. In these cases, if you include multipleContainsoperators 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.
Implementations
A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
- Equals
-
The value of
NameequalsValue. - NotEquals
-
The value of
Namedoesn't equalValue. - Exists
-
The
Nameproperty exists. - NotExists
-
The
Nameproperty does not exist. - GreaterThan
-
The value of
Nameis greater thanValue. Not supported for text properties. - GreaterThanOrEqualTo
-
The value of
Nameis greater than or equal toValue. Not supported for text properties. - LessThan
-
The value of
Nameis less thanValue. Not supported for text properties. - LessThanOrEqualTo
-
The value of
Nameis less than or equal toValue. Not supported for text properties. - In
-
The value of
Nameis one of the comma delimited strings inValue. Only supported for text properties. - Contains
-
The value of
Namecontains the stringValue. Only supported for text properties.A
SearchExpressioncan include theContainsoperator multiple times when the value ofNameis 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
SearchExpressioncan include only oneContainsoperator for all other values ofName. In these cases, if you include multipleContainsoperators in theSearchExpression, the result is the following error message: "'CONTAINS' operator usage limit of 1 exceeded." -
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
Auto Trait Implementations
impl RefUnwindSafe for Filter
impl UnwindSafe for Filter
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more
