You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SageMaker::Types::SearchRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SageMaker::Types::SearchRequest
- Defined in:
- (unknown)
Overview
When passing SearchRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
resource: "TrainingJob", # required, accepts TrainingJob, Experiment, ExperimentTrial, ExperimentTrialComponent
search_expression: {
filters: [
{
name: "ResourcePropertyName", # required
operator: "Equals", # accepts Equals, NotEquals, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo, Contains, Exists, NotExists, In
value: "FilterValue",
},
],
nested_filters: [
{
nested_property_name: "ResourcePropertyName", # required
filters: [ # required
{
name: "ResourcePropertyName", # required
operator: "Equals", # accepts Equals, NotEquals, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo, Contains, Exists, NotExists, In
value: "FilterValue",
},
],
},
],
sub_expressions: [
{
# recursive SearchExpression
},
],
operator: "And", # accepts And, Or
},
sort_by: "ResourcePropertyName",
sort_order: "Ascending", # accepts Ascending, Descending
next_token: "NextToken",
max_results: 1,
}
Instance Attribute Summary collapse
-
#max_results ⇒ Integer
The maximum number of results to return.
-
#next_token ⇒ String
If more than
MaxResults
resources match the specifiedSearchExpression
, the response includes aNextToken
. -
#resource ⇒ String
The name of the Amazon SageMaker resource to search for.
-
#search_expression ⇒ Types::SearchExpression
A Boolean conditional statement.
-
#sort_by ⇒ String
The name of the resource property used to sort the
SearchResults
. -
#sort_order ⇒ String
How
SearchResults
are ordered.
Instance Attribute Details
#max_results ⇒ Integer
The maximum number of results to return.
#next_token ⇒ String
If more than MaxResults
resources match the specified
SearchExpression
, the response includes a NextToken
. The NextToken
can be passed to the next SearchRequest
to continue retrieving
results.
#resource ⇒ String
The name of the Amazon SageMaker resource to search for.
Possible values:
- TrainingJob
- Experiment
- ExperimentTrial
- ExperimentTrialComponent
#search_expression ⇒ Types::SearchExpression
A Boolean conditional statement. Resources must satisfy this condition
to be included in search results. You must provide at least one
subexpression, filter, or nested filter. The maximum number of recursive
SubExpressions
, NestedFilters
, and Filters
that can be included in
a SearchExpression
object is 50.
#sort_by ⇒ String
The name of the resource property used to sort the SearchResults
. The
default is LastModifiedTime
.
#sort_order ⇒ String
How SearchResults
are ordered. Valid values are Ascending
or
Descending
. The default is Descending
.
Possible values:
- Ascending
- Descending