Search - Amazon SageMaker Service

Search

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

Request Syntax

{ "MaxResults": number, "NextToken": "string", "Resource": "string", "SearchExpression": { "Filters": [ { "Name": "string", "Operator": "string", "Value": "string" } ], "NestedFilters": [ { "Filters": [ { "Name": "string", "Operator": "string", "Value": "string" } ], "NestedPropertyName": "string" } ], "Operator": "string", "SubExpressions": [ "SearchExpression" ] }, "SortBy": "string", "SortOrder": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

The maximum number of results to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

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.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

Resource

The name of the Amazon SageMaker resource to search for.

Type: String

Valid Values: TrainingJob | Experiment | ExperimentTrial | ExperimentTrialComponent | Endpoint | ModelPackage | ModelPackageGroup | Pipeline | PipelineExecution | FeatureGroup

Required: Yes

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.

Type: SearchExpression object

Required: No

SortBy

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: .+

Required: No

SortOrder

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

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax

{ "NextToken": "string", "Results": [ { "Endpoint": { "CreationTime": number, "DataCaptureConfig": { "CaptureStatus": "string", "CurrentSamplingPercentage": number, "DestinationS3Uri": "string", "EnableCapture": boolean, "KmsKeyId": "string" }, "EndpointArn": "string", "EndpointConfigName": "string", "EndpointName": "string", "EndpointStatus": "string", "FailureReason": "string", "LastModifiedTime": number, "MonitoringSchedules": [ { "CreationTime": number, "EndpointName": "string", "FailureReason": "string", "LastModifiedTime": number, "LastMonitoringExecutionSummary": { "CreationTime": number, "EndpointName": "string", "FailureReason": "string", "LastModifiedTime": number, "MonitoringExecutionStatus": "string", "MonitoringJobDefinitionName": "string", "MonitoringScheduleName": "string", "MonitoringType": "string", "ProcessingJobArn": "string", "ScheduledTime": number }, "MonitoringScheduleArn": "string", "MonitoringScheduleConfig": { "MonitoringJobDefinition": { "BaselineConfig": { "BaseliningJobName": "string", "ConstraintsResource": { "S3Uri": "string" }, "StatisticsResource": { "S3Uri": "string" } }, "Environment": { "string" : "string" }, "MonitoringAppSpecification": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ImageUri": "string", "PostAnalyticsProcessorSourceUri": "string", "RecordPreprocessorSourceUri": "string" }, "MonitoringInputs": [ { "EndpointInput": { "EndpointName": "string", "EndTimeOffset": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" } } ], "MonitoringOutputConfig": { "KmsKeyId": "string", "MonitoringOutputs": [ { "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "MonitoringResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number } }, "MonitoringJobDefinitionName": "string", "MonitoringType": "string", "ScheduleConfig": { "ScheduleExpression": "string" } }, "MonitoringScheduleName": "string", "MonitoringScheduleStatus": "string", "MonitoringType": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ], "ProductionVariants": [ { "CurrentInstanceCount": number, "CurrentWeight": number, "DeployedImages": [ { "ResolutionTime": number, "ResolvedImage": "string", "SpecifiedImage": "string" } ], "DesiredInstanceCount": number, "DesiredWeight": number, "VariantName": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ] }, "Experiment": { "CreatedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "Description": "string", "DisplayName": "string", "ExperimentArn": "string", "ExperimentName": "string", "LastModifiedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "Source": { "SourceArn": "string", "SourceType": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ] }, "FeatureGroup": { "CreationTime": number, "Description": "string", "EventTimeFeatureName": "string", "FailureReason": "string", "FeatureDefinitions": [ { "FeatureName": "string", "FeatureType": "string" } ], "FeatureGroupArn": "string", "FeatureGroupName": "string", "FeatureGroupStatus": "string", "OfflineStoreConfig": { "DataCatalogConfig": { "Catalog": "string", "Database": "string", "TableName": "string" }, "DisableGlueTableCreation": boolean, "S3StorageConfig": { "KmsKeyId": "string", "S3Uri": "string" } }, "OfflineStoreStatus": { "BlockedReason": "string", "Status": "string" }, "OnlineStoreConfig": { "EnableOnlineStore": boolean, "SecurityConfig": { "KmsKeyId": "string" } }, "RecordIdentifierFeatureName": "string", "RoleArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }, "ModelPackage": { "ApprovalDescription": "string", "CertifyForMarketplace": boolean, "CreatedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "InferenceSpecification": { "Containers": [ { "ContainerHostname": "string", "Image": "string", "ImageDigest": "string", "ModelDataUrl": "string", "ProductId": "string" } ], "SupportedContentTypes": [ "string" ], "SupportedRealtimeInferenceInstanceTypes": [ "string" ], "SupportedResponseMIMETypes": [ "string" ], "SupportedTransformInstanceTypes": [ "string" ] }, "LastModifiedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "MetadataProperties": { "CommitId": "string", "GeneratedBy": "string", "ProjectId": "string", "Repository": "string" }, "ModelApprovalStatus": "string", "ModelMetrics": { "Bias": { "Report": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } }, "Explainability": { "Report": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } }, "ModelDataQuality": { "Constraints": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "Statistics": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } }, "ModelQuality": { "Constraints": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "Statistics": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } } }, "ModelPackageArn": "string", "ModelPackageDescription": "string", "ModelPackageGroupName": "string", "ModelPackageName": "string", "ModelPackageStatus": "string", "ModelPackageStatusDetails": { "ImageScanStatuses": [ { "FailureReason": "string", "Name": "string", "Status": "string" } ], "ValidationStatuses": [ { "FailureReason": "string", "Name": "string", "Status": "string" } ] }, "ModelPackageVersion": number, "SourceAlgorithmSpecification": { "SourceAlgorithms": [ { "AlgorithmName": "string", "ModelDataUrl": "string" } ] }, "Tags": [ { "Key": "string", "Value": "string" } ], "ValidationSpecification": { "ValidationProfiles": [ { "ProfileName": "string", "TransformJobDefinition": { "BatchStrategy": "string", "Environment": { "string" : "string" }, "MaxConcurrentTransforms": number, "MaxPayloadInMB": number, "TransformInput": { "CompressionType": "string", "ContentType": "string", "DataSource": { "S3DataSource": { "S3DataType": "string", "S3Uri": "string" } }, "SplitType": "string" }, "TransformOutput": { "Accept": "string", "AssembleWith": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "TransformResources": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string" } } } ], "ValidationRole": "string" } }, "ModelPackageGroup": { "CreatedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "ModelPackageGroupArn": "string", "ModelPackageGroupDescription": "string", "ModelPackageGroupName": "string", "ModelPackageGroupStatus": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }, "Pipeline": { "CreatedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "LastModifiedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "LastRunTime": number, "PipelineArn": "string", "PipelineDescription": "string", "PipelineDisplayName": "string", "PipelineName": "string", "PipelineStatus": "string", "RoleArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }, "PipelineExecution": { "CreatedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "LastModifiedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "PipelineArn": "string", "PipelineExecutionArn": "string", "PipelineExecutionDescription": "string", "PipelineExecutionDisplayName": "string", "PipelineExecutionStatus": "string", "PipelineParameters": [ { "Name": "string", "Value": "string" } ] }, "TrainingJob": { "AlgorithmSpecification": { "AlgorithmName": "string", "EnableSageMakerMetricsTimeSeries": boolean, "MetricDefinitions": [ { "Name": "string", "Regex": "string" } ], "TrainingImage": "string", "TrainingInputMode": "string" }, "AutoMLJobArn": "string", "BillableTimeInSeconds": number, "CheckpointConfig": { "LocalPath": "string", "S3Uri": "string" }, "CreationTime": number, "DebugHookConfig": { "CollectionConfigurations": [ { "CollectionName": "string", "CollectionParameters": { "string" : "string" } } ], "HookParameters": { "string" : "string" }, "LocalPath": "string", "S3OutputPath": "string" }, "DebugRuleConfigurations": [ { "InstanceType": "string", "LocalPath": "string", "RuleConfigurationName": "string", "RuleEvaluatorImage": "string", "RuleParameters": { "string" : "string" }, "S3OutputPath": "string", "VolumeSizeInGB": number } ], "DebugRuleEvaluationStatuses": [ { "LastModifiedTime": number, "RuleConfigurationName": "string", "RuleEvaluationJobArn": "string", "RuleEvaluationStatus": "string", "StatusDetails": "string" } ], "EnableInterContainerTrafficEncryption": boolean, "EnableManagedSpotTraining": boolean, "EnableNetworkIsolation": boolean, "ExperimentConfig": { "ExperimentName": "string", "TrialComponentDisplayName": "string", "TrialName": "string" }, "FailureReason": "string", "FinalMetricDataList": [ { "MetricName": "string", "Timestamp": number, "Value": number } ], "HyperParameters": { "string" : "string" }, "InputDataConfig": [ { "ChannelName": "string", "CompressionType": "string", "ContentType": "string", "DataSource": { "FileSystemDataSource": { "DirectoryPath": "string", "FileSystemAccessMode": "string", "FileSystemId": "string", "FileSystemType": "string" }, "S3DataSource": { "AttributeNames": [ "string" ], "S3DataDistributionType": "string", "S3DataType": "string", "S3Uri": "string" } }, "InputMode": "string", "RecordWrapperType": "string", "ShuffleConfig": { "Seed": number } } ], "LabelingJobArn": "string", "LastModifiedTime": number, "ModelArtifacts": { "S3ModelArtifacts": "string" }, "OutputDataConfig": { "KmsKeyId": "string", "S3OutputPath": "string" }, "ResourceConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "RoleArn": "string", "SecondaryStatus": "string", "SecondaryStatusTransitions": [ { "EndTime": number, "StartTime": number, "Status": "string", "StatusMessage": "string" } ], "StoppingCondition": { "MaxRuntimeInSeconds": number, "MaxWaitTimeInSeconds": number }, "Tags": [ { "Key": "string", "Value": "string" } ], "TensorBoardOutputConfig": { "LocalPath": "string", "S3OutputPath": "string" }, "TrainingEndTime": number, "TrainingJobArn": "string", "TrainingJobName": "string", "TrainingJobStatus": "string", "TrainingStartTime": number, "TrainingTimeInSeconds": number, "TuningJobArn": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "Trial": { "CreatedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "DisplayName": "string", "ExperimentName": "string", "LastModifiedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "MetadataProperties": { "CommitId": "string", "GeneratedBy": "string", "ProjectId": "string", "Repository": "string" }, "Source": { "SourceArn": "string", "SourceType": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "TrialArn": "string", "TrialComponentSummaries": [ { "CreatedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "TrialComponentArn": "string", "TrialComponentName": "string", "TrialComponentSource": { "SourceArn": "string", "SourceType": "string" } } ], "TrialName": "string" }, "TrialComponent": { "CreatedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "DisplayName": "string", "EndTime": number, "InputArtifacts": { "string" : { "MediaType": "string", "Value": "string" } }, "LastModifiedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "MetadataProperties": { "CommitId": "string", "GeneratedBy": "string", "ProjectId": "string", "Repository": "string" }, "Metrics": [ { "Avg": number, "Count": number, "Last": number, "Max": number, "MetricName": "string", "Min": number, "SourceArn": "string", "StdDev": number, "TimeStamp": number } ], "OutputArtifacts": { "string" : { "MediaType": "string", "Value": "string" } }, "Parameters": { "string" : { "NumberValue": number, "StringValue": "string" } }, "Parents": [ { "ExperimentName": "string", "TrialName": "string" } ], "Source": { "SourceArn": "string", "SourceType": "string" }, "SourceDetail": { "ProcessingJob": { "AppSpecification": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ImageUri": "string" }, "AutoMLJobArn": "string", "CreationTime": number, "Environment": { "string" : "string" }, "ExitMessage": "string", "ExperimentConfig": { "ExperimentName": "string", "TrialComponentDisplayName": "string", "TrialName": "string" }, "FailureReason": "string", "LastModifiedTime": number, "MonitoringScheduleArn": "string", "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "ProcessingEndTime": number, "ProcessingInputs": [ { "AppManaged": boolean, "DatasetDefinition": { "AthenaDatasetDefinition": { "Catalog": "string", "Database": "string", "KmsKeyId": "string", "OutputCompression": "string", "OutputFormat": "string", "OutputS3Uri": "string", "QueryString": "string", "WorkGroup": "string" }, "DataDistributionType": "string", "InputMode": "string", "LocalPath": "string", "RedshiftDatasetDefinition": { "ClusterId": "string", "ClusterRoleArn": "string", "Database": "string", "DbUser": "string", "KmsKeyId": "string", "OutputCompression": "string", "OutputFormat": "string", "OutputS3Uri": "string", "QueryString": "string" } }, "InputName": "string", "S3Input": { "LocalPath": "string", "S3CompressionType": "string", "S3DataDistributionType": "string", "S3DataType": "string", "S3InputMode": "string", "S3Uri": "string" } } ], "ProcessingJobArn": "string", "ProcessingJobName": "string", "ProcessingJobStatus": "string", "ProcessingOutputConfig": { "KmsKeyId": "string", "Outputs": [ { "AppManaged": boolean, "FeatureStoreOutput": { "FeatureGroupName": "string" }, "OutputName": "string", "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "ProcessingResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "ProcessingStartTime": number, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number }, "Tags": [ { "Key": "string", "Value": "string" } ], "TrainingJobArn": "string" }, "SourceArn": "string", "TrainingJob": { "AlgorithmSpecification": { "AlgorithmName": "string", "EnableSageMakerMetricsTimeSeries": boolean, "MetricDefinitions": [ { "Name": "string", "Regex": "string" } ], "TrainingImage": "string", "TrainingInputMode": "string" }, "AutoMLJobArn": "string", "BillableTimeInSeconds": number, "CheckpointConfig": { "LocalPath": "string", "S3Uri": "string" }, "CreationTime": number, "DebugHookConfig": { "CollectionConfigurations": [ { "CollectionName": "string", "CollectionParameters": { "string" : "string" } } ], "HookParameters": { "string" : "string" }, "LocalPath": "string", "S3OutputPath": "string" }, "DebugRuleConfigurations": [ { "InstanceType": "string", "LocalPath": "string", "RuleConfigurationName": "string", "RuleEvaluatorImage": "string", "RuleParameters": { "string" : "string" }, "S3OutputPath": "string", "VolumeSizeInGB": number } ], "DebugRuleEvaluationStatuses": [ { "LastModifiedTime": number, "RuleConfigurationName": "string", "RuleEvaluationJobArn": "string", "RuleEvaluationStatus": "string", "StatusDetails": "string" } ], "EnableInterContainerTrafficEncryption": boolean, "EnableManagedSpotTraining": boolean, "EnableNetworkIsolation": boolean, "ExperimentConfig": { "ExperimentName": "string", "TrialComponentDisplayName": "string", "TrialName": "string" }, "FailureReason": "string", "FinalMetricDataList": [ { "MetricName": "string", "Timestamp": number, "Value": number } ], "HyperParameters": { "string" : "string" }, "InputDataConfig": [ { "ChannelName": "string", "CompressionType": "string", "ContentType": "string", "DataSource": { "FileSystemDataSource": { "DirectoryPath": "string", "FileSystemAccessMode": "string", "FileSystemId": "string", "FileSystemType": "string" }, "S3DataSource": { "AttributeNames": [ "string" ], "S3DataDistributionType": "string", "S3DataType": "string", "S3Uri": "string" } }, "InputMode": "string", "RecordWrapperType": "string", "ShuffleConfig": { "Seed": number } } ], "LabelingJobArn": "string", "LastModifiedTime": number, "ModelArtifacts": { "S3ModelArtifacts": "string" }, "OutputDataConfig": { "KmsKeyId": "string", "S3OutputPath": "string" }, "ResourceConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "RoleArn": "string", "SecondaryStatus": "string", "SecondaryStatusTransitions": [ { "EndTime": number, "StartTime": number, "Status": "string", "StatusMessage": "string" } ], "StoppingCondition": { "MaxRuntimeInSeconds": number, "MaxWaitTimeInSeconds": number }, "Tags": [ { "Key": "string", "Value": "string" } ], "TensorBoardOutputConfig": { "LocalPath": "string", "S3OutputPath": "string" }, "TrainingEndTime": number, "TrainingJobArn": "string", "TrainingJobName": "string", "TrainingJobStatus": "string", "TrainingStartTime": number, "TrainingTimeInSeconds": number, "TuningJobArn": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "TransformJob": { "AutoMLJobArn": "string", "BatchStrategy": "string", "CreationTime": number, "DataProcessing": { "InputFilter": "string", "JoinSource": "string", "OutputFilter": "string" }, "Environment": { "string" : "string" }, "ExperimentConfig": { "ExperimentName": "string", "TrialComponentDisplayName": "string", "TrialName": "string" }, "FailureReason": "string", "LabelingJobArn": "string", "MaxConcurrentTransforms": number, "MaxPayloadInMB": number, "ModelClientConfig": { "InvocationsMaxRetries": number, "InvocationsTimeoutInSeconds": number }, "ModelName": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TransformEndTime": number, "TransformInput": { "CompressionType": "string", "ContentType": "string", "DataSource": { "S3DataSource": { "S3DataType": "string", "S3Uri": "string" } }, "SplitType": "string" }, "TransformJobArn": "string", "TransformJobName": "string", "TransformJobStatus": "string", "TransformOutput": { "Accept": "string", "AssembleWith": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "TransformResources": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string" }, "TransformStartTime": number } }, "StartTime": number, "Status": { "Message": "string", "PrimaryStatus": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "TrialComponentArn": "string", "TrialComponentName": "string" } } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Results

A list of SearchRecord objects.

Type: Array of SearchRecord objects

Errors

For information about the errors that are common to all actions, see Common Errors.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: