You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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
  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

Instance Attribute Details

#max_resultsInteger

The maximum number of results to return in a SearchResponse.

Returns:

  • (Integer)


10422
10423
10424
10425
10426
10427
10428
10429
10430
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10422

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 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.

Returns:

  • (String)


10422
10423
10424
10425
10426
10427
10428
10429
10430
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10422

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. Currently, the only valid Resource value is TrainingJob.

Returns:

  • (String)


10422
10423
10424
10425
10426
10427
10428
10429
10430
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10422

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. 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.



10422
10423
10424
10425
10426
10427
10428
10429
10430
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10422

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)


10422
10423
10424
10425
10426
10427
10428
10429
10430
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10422

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)


10422
10423
10424
10425
10426
10427
10428
10429
10430
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10422

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