SageMaker / Client / search
search#
- SageMaker.Client.search(**kwargs)#
Finds SageMaker resources that match a search query. Matching resources are returned as a list of
SearchRecordobjects 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.
Note
The Search API may provide access to otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference for more information.
See also: AWS API Documentation
Request Syntax
response = client.search( Resource='TrainingJob'|'Experiment'|'ExperimentTrial'|'ExperimentTrialComponent'|'Endpoint'|'Model'|'ModelPackage'|'ModelPackageGroup'|'Pipeline'|'PipelineExecution'|'FeatureGroup'|'FeatureMetadata'|'Image'|'ImageVersion'|'Project'|'HyperParameterTuningJob'|'ModelCard', SearchExpression={ 'Filters': [ { 'Name': 'string', 'Operator': 'Equals'|'NotEquals'|'GreaterThan'|'GreaterThanOrEqualTo'|'LessThan'|'LessThanOrEqualTo'|'Contains'|'Exists'|'NotExists'|'In', 'Value': 'string' }, ], 'NestedFilters': [ { 'NestedPropertyName': 'string', 'Filters': [ { 'Name': 'string', 'Operator': 'Equals'|'NotEquals'|'GreaterThan'|'GreaterThanOrEqualTo'|'LessThan'|'LessThanOrEqualTo'|'Contains'|'Exists'|'NotExists'|'In', 'Value': 'string' }, ] }, ], 'SubExpressions': [ {'... recursive ...'}, ], 'Operator': 'And'|'Or' }, SortBy='string', SortOrder='Ascending'|'Descending', NextToken='string', MaxResults=123, CrossAccountFilterOption='SameAccount'|'CrossAccount' )
- Parameters:
Resource (string) –
[REQUIRED]
The name of the SageMaker resource to search for.
SearchExpression (dict) –
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, andFiltersthat can be included in aSearchExpressionobject is 50.Filters (list) –
A list of filter objects.
(dict) –
A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.
If you specify a
Value, but not anOperator, SageMaker uses the equals operator.In search, there are several property types:
Metrics
To define a metric filter, enter a value using the form
"Metrics.<name>", where<name>is a metric name. For example, the following filter searches for training jobs with an"accuracy"metric greater than"0.9":{"Name": "Metrics.accuracy","Operator": "GreaterThan","Value": "0.9"}HyperParameters
To define a hyperparameter filter, enter a value with the form
"HyperParameters.<name>". Decimal hyperparameter values are treated as a decimal in a comparison if the specifiedValueis also a decimal value. If the specifiedValueis an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a"learning_rate"hyperparameter that is less than"0.5":{"Name": "HyperParameters.learning_rate","Operator": "LessThan","Value": "0.5"}Tags
To define a tag filter, enter a value with the form
Tags.<key>.Name (string) – [REQUIRED]
A resource property name. For example,
TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.Operator (string) –
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
Equals
The value of
NameequalsValue.NotEquals
The value of
Namedoesn’t equalValue.Exists
The
Nameproperty exists.NotExists
The
Nameproperty does not exist.GreaterThan
The value of
Nameis greater thanValue. Not supported for text properties.GreaterThanOrEqualTo
The value of
Nameis greater than or equal toValue. Not supported for text properties.LessThan
The value of
Nameis less thanValue. Not supported for text properties.LessThanOrEqualTo
The value of
Nameis less than or equal toValue. Not supported for text properties.In
The value of
Nameis one of the comma delimited strings inValue. Only supported for text properties.Contains
The value of
Namecontains the stringValue. Only supported for text properties.A
SearchExpressioncan include theContainsoperator multiple times when the value ofNameis one of the following:Experiment.DisplayNameExperiment.ExperimentNameExperiment.TagsTrial.DisplayNameTrial.TrialNameTrial.TagsTrialComponent.DisplayNameTrialComponent.TrialComponentNameTrialComponent.TagsTrialComponent.InputArtifactsTrialComponent.OutputArtifacts
A
SearchExpressioncan include only oneContainsoperator for all other values ofName. In these cases, if you include multipleContainsoperators in theSearchExpression, the result is the following error message: “'CONTAINS' operator usage limit of 1 exceeded.”Value (string) –
A value used with
NameandOperatorto determine which resources satisfy the filter’s condition. For numerical properties,Valuemust be an integer or floating-point decimal. For timestamp properties,Valuemust be an ISO 8601 date-time string of the following format:YYYY-mm-dd'T'HH:MM:SS.
NestedFilters (list) –
A list of nested filter objects.
(dict) –
A list of nested Filter objects. A resource must satisfy the conditions of all filters to be included in the results returned from the Search API.
For example, to filter on a training job’s
InputDataConfigproperty with a specific channel name andS3Uriprefix, define the following filters:'{Name:"InputDataConfig.ChannelName", "Operator":"Equals", "Value":"train"}','{Name:"InputDataConfig.DataSource.S3DataSource.S3Uri", "Operator":"Contains", "Value":"mybucket/catdata"}'
NestedPropertyName (string) – [REQUIRED]
The name of the property to use in the nested filters. The value must match a listed property name, such as
InputDataConfig.Filters (list) – [REQUIRED]
A list of filters. Each filter acts on a property. Filters must contain at least one
Filtersvalue. For example, aNestedFilterscall might include a filter on thePropertyNameparameter of theInputDataConfigproperty:InputDataConfig.DataSource.S3DataSource.S3Uri.(dict) –
A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.
If you specify a
Value, but not anOperator, SageMaker uses the equals operator.In search, there are several property types:
Metrics
To define a metric filter, enter a value using the form
"Metrics.<name>", where<name>is a metric name. For example, the following filter searches for training jobs with an"accuracy"metric greater than"0.9":{"Name": "Metrics.accuracy","Operator": "GreaterThan","Value": "0.9"}HyperParameters
To define a hyperparameter filter, enter a value with the form
"HyperParameters.<name>". Decimal hyperparameter values are treated as a decimal in a comparison if the specifiedValueis also a decimal value. If the specifiedValueis an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a"learning_rate"hyperparameter that is less than"0.5":{"Name": "HyperParameters.learning_rate","Operator": "LessThan","Value": "0.5"}Tags
To define a tag filter, enter a value with the form
Tags.<key>.Name (string) – [REQUIRED]
A resource property name. For example,
TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.Operator (string) –
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
Equals
The value of
NameequalsValue.NotEquals
The value of
Namedoesn’t equalValue.Exists
The
Nameproperty exists.NotExists
The
Nameproperty does not exist.GreaterThan
The value of
Nameis greater thanValue. Not supported for text properties.GreaterThanOrEqualTo
The value of
Nameis greater than or equal toValue. Not supported for text properties.LessThan
The value of
Nameis less thanValue. Not supported for text properties.LessThanOrEqualTo
The value of
Nameis less than or equal toValue. Not supported for text properties.In
The value of
Nameis one of the comma delimited strings inValue. Only supported for text properties.Contains
The value of
Namecontains the stringValue. Only supported for text properties.A
SearchExpressioncan include theContainsoperator multiple times when the value ofNameis one of the following:Experiment.DisplayNameExperiment.ExperimentNameExperiment.TagsTrial.DisplayNameTrial.TrialNameTrial.TagsTrialComponent.DisplayNameTrialComponent.TrialComponentNameTrialComponent.TagsTrialComponent.InputArtifactsTrialComponent.OutputArtifacts
A
SearchExpressioncan include only oneContainsoperator for all other values ofName. In these cases, if you include multipleContainsoperators in theSearchExpression, the result is the following error message: “'CONTAINS' operator usage limit of 1 exceeded.”Value (string) –
A value used with
NameandOperatorto determine which resources satisfy the filter’s condition. For numerical properties,Valuemust be an integer or floating-point decimal. For timestamp properties,Valuemust be an ISO 8601 date-time string of the following format:YYYY-mm-dd'T'HH:MM:SS.
SubExpressions (list) –
A list of search expression objects.
(dict) –
A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression’s condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A
SearchExpressioncan contain up to twenty elements.A
SearchExpressioncontains the following components:A list of
Filterobjects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.A list of
NestedFilterobjects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.A list of
SearchExpressionobjects. A search expression object can be nested in a list of search expression objects.A Boolean operator:
AndorOr.
Operator (string) –
A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify
And. If only a single conditional statement needs to be true for the entire search expression to be true, specifyOr. The default value isAnd.
SortBy (string) – The name of the resource property used to sort the
SearchResults. The default isLastModifiedTime.SortOrder (string) – How
SearchResultsare ordered. Valid values areAscendingorDescending. The default isDescending.NextToken (string) – If more than
MaxResultsresources match the specifiedSearchExpression, the response includes aNextToken. TheNextTokencan be passed to the nextSearchRequestto continue retrieving results.MaxResults (integer) – The maximum number of results to return.
CrossAccountFilterOption (string) – 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"ornullthe search results will only include resources from your account. Default isnull. 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 ``ResourceCatalog``s viewable is 1000.
- Return type:
dict
- Returns:
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.