Class: Aws::SageMaker::Types::SearchRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass SearchRequest data as a 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

Instance Attribute Details

#max_resultsInteger

The maximum number of results to return.

Returns:

  • (Integer)


17650
17651
17652
17653
17654
17655
17656
17657
17658
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 17650

class SearchRequest < Struct.new(
  :resource,
  :search_expression,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


17650
17651
17652
17653
17654
17655
17656
17657
17658
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 17650

class SearchRequest < Struct.new(
  :resource,
  :search_expression,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results)
  include Aws::Structure
end

#resourceString

The name of the Amazon SageMaker resource to search for.

Returns:

  • (String)


17650
17651
17652
17653
17654
17655
17656
17657
17658
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 17650

class SearchRequest < Struct.new(
  :resource,
  :search_expression,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results)
  include Aws::Structure
end

#search_expressionTypes::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.



17650
17651
17652
17653
17654
17655
17656
17657
17658
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 17650

class SearchRequest < Struct.new(
  :resource,
  :search_expression,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results)
  include Aws::Structure
end

#sort_byString

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

Returns:

  • (String)


17650
17651
17652
17653
17654
17655
17656
17657
17658
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 17650

class SearchRequest < Struct.new(
  :resource,
  :search_expression,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results)
  include Aws::Structure
end

#sort_orderString

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

Returns:

  • (String)


17650
17651
17652
17653
17654
17655
17656
17657
17658
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 17650

class SearchRequest < Struct.new(
  :resource,
  :search_expression,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results)
  include Aws::Structure
end