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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cross_account_filter_optionString

A cross account filter option. When the value is "CrossAccount" the search results will only include resources made discoverable to you from other accounts. When the value is "SameAccount" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.

Returns:

  • (String)


38427
38428
38429
38430
38431
38432
38433
38434
38435
38436
38437
38438
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 38427

class SearchRequest < Struct.new(
  :resource,
  :search_expression,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :cross_account_filter_option,
  :visibility_conditions)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return.

Returns:

  • (Integer)


38427
38428
38429
38430
38431
38432
38433
38434
38435
38436
38437
38438
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 38427

class SearchRequest < Struct.new(
  :resource,
  :search_expression,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :cross_account_filter_option,
  :visibility_conditions)
  SENSITIVE = []
  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)


38427
38428
38429
38430
38431
38432
38433
38434
38435
38436
38437
38438
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 38427

class SearchRequest < Struct.new(
  :resource,
  :search_expression,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :cross_account_filter_option,
  :visibility_conditions)
  SENSITIVE = []
  include Aws::Structure
end

#resourceString

The name of the SageMaker resource to search for.

Returns:

  • (String)


38427
38428
38429
38430
38431
38432
38433
38434
38435
38436
38437
38438
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 38427

class SearchRequest < Struct.new(
  :resource,
  :search_expression,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :cross_account_filter_option,
  :visibility_conditions)
  SENSITIVE = []
  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.



38427
38428
38429
38430
38431
38432
38433
38434
38435
38436
38437
38438
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 38427

class SearchRequest < Struct.new(
  :resource,
  :search_expression,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :cross_account_filter_option,
  :visibility_conditions)
  SENSITIVE = []
  include Aws::Structure
end

#sort_byString

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

Returns:

  • (String)


38427
38428
38429
38430
38431
38432
38433
38434
38435
38436
38437
38438
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 38427

class SearchRequest < Struct.new(
  :resource,
  :search_expression,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :cross_account_filter_option,
  :visibility_conditions)
  SENSITIVE = []
  include Aws::Structure
end

#sort_orderString

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

Returns:

  • (String)


38427
38428
38429
38430
38431
38432
38433
38434
38435
38436
38437
38438
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 38427

class SearchRequest < Struct.new(
  :resource,
  :search_expression,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :cross_account_filter_option,
  :visibility_conditions)
  SENSITIVE = []
  include Aws::Structure
end

#visibility_conditionsArray<Types::VisibilityConditions>

Limits the results of your search request to the resources that you can access.

Returns:



38427
38428
38429
38430
38431
38432
38433
38434
38435
38436
38437
38438
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 38427

class SearchRequest < Struct.new(
  :resource,
  :search_expression,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :cross_account_filter_option,
  :visibility_conditions)
  SENSITIVE = []
  include Aws::Structure
end