Class: Aws::SageMaker::Types::SearchRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SageMaker::Types::SearchRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-sagemaker/types.rb
Overview
When making an API call, you may pass SearchRequest data as a hash:
{
resource: "TrainingJob", # required, accepts TrainingJob
search_expression: {
filters: [
{
name: "ResourcePropertyName", # required
operator: "Equals", # accepts Equals, NotEquals, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo, Contains
value: "FilterValue",
},
],
nested_filters: [
{
nested_property_name: "ResourcePropertyName", # required
filters: [ # required
{
name: "ResourcePropertyName", # required
operator: "Equals", # accepts Equals, NotEquals, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo, Contains
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 in a ‘SearchResponse`.
-
#next_token ⇒ String
If more than ‘MaxResults` resource objects match the specified `SearchExpression`, the `SearchResponse` includes a `NextToken`.
-
#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 in a ‘SearchResponse`.
9645 9646 9647 9648 9649 9650 9651 9652 9653 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 9645 class SearchRequest < Struct.new( :resource, :search_expression, :sort_by, :sort_order, :next_token, :max_results) include Aws::Structure end |
#next_token ⇒ String
If more than ‘MaxResults` resource objects match the specified `SearchExpression`, the `SearchResponse` includes a `NextToken`. The `NextToken` can be passed to the next `SearchRequest` to continue retrieving results for the specified `SearchExpression` and `Sort` parameters.
9645 9646 9647 9648 9649 9650 9651 9652 9653 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 9645 class SearchRequest < Struct.new( :resource, :search_expression, :sort_by, :sort_order, :next_token, :max_results) include Aws::Structure end |
#resource ⇒ String
The name of the Amazon SageMaker resource to search for. Currently, the only valid ‘Resource` value is `TrainingJob`.
9645 9646 9647 9648 9649 9650 9651 9652 9653 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 9645 class SearchRequest < Struct.new( :resource, :search_expression, :sort_by, :sort_order, :next_token, :max_results) include Aws::Structure end |
#search_expression ⇒ Types::SearchExpression
A Boolean conditional statement. Resource objects 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.
9645 9646 9647 9648 9649 9650 9651 9652 9653 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 9645 class SearchRequest < Struct.new( :resource, :search_expression, :sort_by, :sort_order, :next_token, :max_results) include Aws::Structure end |
#sort_by ⇒ String
The name of the resource property used to sort the ‘SearchResults`. The default is `LastModifiedTime`.
9645 9646 9647 9648 9649 9650 9651 9652 9653 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 9645 class SearchRequest < Struct.new( :resource, :search_expression, :sort_by, :sort_order, :next_token, :max_results) include Aws::Structure end |
#sort_order ⇒ String
How ‘SearchResults` are ordered. Valid values are `Ascending` or `Descending`. The default is `Descending`.
9645 9646 9647 9648 9649 9650 9651 9652 9653 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 9645 class SearchRequest < Struct.new( :resource, :search_expression, :sort_by, :sort_order, :next_token, :max_results) include Aws::Structure end |