AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the Search operation. Finds SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.

You can query against the following value types: numeric, text, Boolean, and timestamp.

The Search API may provide access to otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference for more information.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SageMaker.AmazonSageMakerRequest
      Amazon.SageMaker.Model.SearchRequest

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C# 
public class SearchRequest : AmazonSageMakerRequest
         IAmazonWebServiceRequest

The SearchRequest type exposes the following members

Constructors

NameDescription
Public Method SearchRequest()

Properties

NameTypeDescription
Public Property CrossAccountFilterOption Amazon.SageMaker.CrossAccountFilterOption

Gets and sets the property CrossAccountFilterOption.

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.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

The maximum number of results to return.

Public Property NextToken System.String

Gets and sets the property NextToken.

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.

Public Property Resource Amazon.SageMaker.ResourceType

Gets and sets the property Resource.

The name of the SageMaker resource to search for.

Public Property SearchExpression Amazon.SageMaker.Model.SearchExpression

Gets and sets the property 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.

Public Property SortBy System.String

Gets and sets the property SortBy.

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

Public Property SortOrder Amazon.SageMaker.SearchSortOrder

Gets and sets the property SortOrder.

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

Public Property VisibilityConditions System.Collections.Generic.List<Amazon.SageMaker.Model.VisibilityConditions>

Gets and sets the property VisibilityConditions.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5