Data retrieval APIs for Amazon SageMaker
Amazon SageMaker provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| BatchDescribeModelPackage | Describe one or more ModelPackages | Read |
| BatchGetMetrics | Retrieve metrics associated with SageMaker Resources such as Training Jobs or Trial Components | Read |
| BatchGetRecord | Get a batch of records from one or more feature groups | Read |
| CreateHubContentPresignedUrls | Generate S3 presigned URLs with GetObject permission for accessing model artifacts | Read |
| DescribeAction | Get information about an action | Read |
| DescribeAlgorithm | Describe an algorithm | Read |
| DescribeApp | Describe an App | Read |
| DescribeAppImageConfig | Describe an AppImageConfig | Read |
| DescribeArtifact | Get information about an artifact | Read |
| DescribeAutoMLJob | Describe an AutoML job that was created via the CreateAutoMLJob API | Read |
| DescribeAutoMLJobV2 | Describe an AutoML job that was created via the CreateAutoMLJobV2 API | Read |
| DescribeCluster | Return information about a SageMaker HyperPod cluster | Read |
| DescribeClusterEvent | Return information about an Event within a SageMaker HyperPod cluster | Read |
| DescribeClusterInference | Get information about the inference operator for a SageMaker HyperPod cluster | Read |
| DescribeClusterNode | Return information about a SageMaker HyperPod cluster node | Read |
| DescribeClusterSchedulerConfig | Get information about a cluster scheduler config | Read |
| DescribeCodeRepository | Describe a CodeRepository | Read |
| DescribeCompilationJob | Return information about a compilation job | Read |
| DescribeComputeQuota | Get information about a compute quota | Read |
| DescribeContext | Get information about a context | Read |
| DescribeDataQualityJobDefinition | Return information about a data quality job definition | Read |
| DescribeDevice | Access information about a device | Read |
| DescribeDeviceFleet | Access information about a device fleet | Read |
| DescribeDomain | Describe a Domain | Read |
| DescribeEdgeDeploymentPlan | Access information about an edge deployment plan | Read |
| DescribeEdgePackagingJob | Access information about an edge packaging job | Read |
| DescribeEndpoint | Return the description of an endpoint | Read |
| DescribeEndpointConfig | Return the description of an endpoint configuration, which was created using the CreateEndpointConfig API | Read |
| DescribeExperiment | Return information about an experiment | Read |
| DescribeFeatureGroup | Return information about a feature group | Read |
| DescribeFeatureMetadata | Return information about a feature metadata | Read |
| DescribeFlowDefinition | Return information about the specified flow definition | Read |
| DescribeHub | Describe hubs | Read |
| DescribeHubContent | Describe hub content | Read |
| DescribeHumanLoop | Return information about the specified human loop | Read |
| DescribeHumanTaskUi | Return detailed information about the specified human review workflow user interface | Read |
| DescribeHyperParameterTuningJob | Describe a hyper parameter tuning job that was created via the CreateHyperParameterTuningJob API | Read |
| DescribeImage | Return information about a SageMaker Image | Read |
| DescribeImageVersion | Return information about a SageMaker ImageVersion | Read |
| DescribeInferenceComponent | Return the description of an inference component | Read |
| DescribeInferenceExperiment | Get information about an inference experiment | Read |
| DescribeInferenceRecommendationsJob | Get information about an inference recommendations job | Read |
| DescribeLabelingJob | Return information about a labeling job | Read |
| DescribeLineageGroup | Describe a lineage group | Read |
| DescribeMlflowTrackingServer | Get information about an MLflow tracking server | Read |
| DescribeModel | Describe a model that you created using the CreateModel API | Read |
| DescribeModelBiasJobDefinition | Return information about a model bias job definition | Read |
| DescribeModelCard | Get information about a model card | Read |
| DescribeModelCardExportJob | Get information about a model card export job | Read |
| DescribeModelExplainabilityJobDefinition | Return information about a model explainability job definition | Read |
| DescribeModelPackage | Describe a ModelPackage | Read |
| DescribeModelPackageGroup | Describe a ModelPackageGroup | Read |
| DescribeModelQualityJobDefinition | Return information about a model quality job definition | Read |
| DescribeMonitoringSchedule | Return information about a monitoring schedule | Read |
| DescribeNotebookInstance | Return information about a notebook instance | Read |
| DescribeNotebookInstanceLifecycleConfig | Describe a notebook instance lifecycle configuration that was created via the CreateNotebookInstanceLifecycleConfig API | Read |
| DescribeOptimizationJob | Return information about an optimization job | Read |
| DescribePartnerApp | Describe an Amazon SageMaker Partner AI App | Read |
| DescribePipeline | Get information about a pipeline | Read |
| DescribePipelineDefinitionForExecution | Get the pipeline definition for a pipeline execution | Read |
| DescribePipelineExecution | Get information about a pipeline execution | Read |
| DescribeProcessingJob | Return information about a processing job | Read |
| DescribeProject | Describe a project | Read |
| DescribeReservedCapacity | Return information about a specified Reserved Capacity | Read |
| DescribeSharedModel | Describe a shared model in a SageMaker Studio application | Read |
| DescribeSpace | Describe a Space | Read |
| DescribeStudioLifecycleConfig | Describe a Studio Lifecycle Configuration | Read |
| DescribeSubscribedWorkteam | Return information about a subscribed workteam | Read |
| DescribeTrainingJob | Return information about a training job | Read |
| DescribeTrainingPlan | Return information about a specified training plan | Read |
| DescribeTransformJob | Return information about a transform job | Read |
| DescribeTrial | Return information about a trial | Read |
| DescribeTrialComponent | Return information about a trial component | Read |
| DescribeUserProfile | Describe a UserProfile | Read |
| DescribeWorkforce | Return information about a workforce | Read |
| DescribeWorkteam | Return information about a workteam | Read |
| GetDeployments | Get deployment plan for device | Read |
| GetDeviceFleetReport | Access a summary of the devices in a device fleet | Read |
| GetDeviceRegistration | Get device registration. After you deploy a model onto edge devices this api is used to get current device registration | Read |
| GetLineageGroupPolicy | Retreive a lineage group policy | Read |
| GetModelPackageGroupPolicy | Get a ModelPackageGroup policy | Read |
| GetRecord | Get a record from a feature group | Read |
| GetResourcePolicy | Grants AWS Resource Access Manager permission to retrieve a resource policy on a SageMaker resource that supports cross-account sharing | Read |
| GetSagemakerServicecatalogPortfolioStatus | Get a SageMaker Service Catalog Portfolio | Read |
| GetScalingConfigurationRecommendation | Get a scaling policy configuration recommendation | Read |
| GetSearchSuggestions | Get search suggestions when provided with a keyword | Read |
| InvokeEndpoint | Invoke an endpoint. After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint | Read |
| InvokeEndpointAsync | Get inferences from the hosted model at the specified endpoint in an asynchronous manner | Read |
| InvokeEndpointWithResponseStream | Get the inference response as a stream from the specified endpoint | Read |
| ListActions | List actions | List |
| ListAlgorithms | List Algorithms | List |
| ListAliases | List Aliases that belong to a SageMaker Image or Sagemaker ImageVersion | List |
| ListAppImageConfigs | List the AppImageConfigs in your account | List |
| ListApps | List the Apps in your account | List |
| ListArtifacts | List artifacts | List |
| ListAssociations | List associations | List |
| ListAutoMLJobs | List AutoML jobs | List |
| ListCandidatesForAutoMLJob | Lists candidates for an AutoML job | List |
| ListClusterEvents | List events within a SageMaker HyperPod cluster | List |
| ListClusterNodes | List nodes within a SageMaker HyperPod cluster | List |
| ListClusterSchedulerConfigs | List cluster scheduler configs | List |
| ListClusters | List SageMaker HyperPod clusters | List |
| ListCodeRepositories | List code repositories | List |
| ListCompilationJobs | List compilation jobs | List |
| ListComputeQuotas | List compute quotas | List |
| ListContexts | List contexts | List |
| ListDataQualityJobDefinitions | List data quality job definitions | List |
| ListDeviceFleets | List device fleets | List |
| ListDevices | List devices | List |
| ListDomains | List the Domains in your account | List |
| ListEdgeDeploymentPlans | List edge deployment plans | List |
| ListEdgePackagingJobs | List edge packaging jobs | List |
| ListEndpointConfigs | List endpoint configurations | List |
| ListEndpoints | List endpoints | List |
| ListExperiments | List experiments | List |
| ListFeatureGroups | List feature groups | List |
| ListFlowDefinitions | Return summary information about flow definitions, given the specified parameters | List |
| ListHubContentVersions | List all versions of hub content | List |
| ListHubContents | List newest versions of hub content | List |
| ListHubs | List hubs | List |
| ListHumanLoops | Return summary information about human loops, given the specified parameters | List |
| ListHumanTaskUis | Return summary information about human review workflow user interfaces, given the specified parameters | List |
| ListHyperParameterTuningJobs | List hyper parameter tuning jobs | List |
| ListImageVersions | List ImageVersions that belong to a SageMaker Image | List |
| ListImages | List SageMaker Images in your account | List |
| ListInferenceComponents | List inference components | List |
| ListInferenceExperiments | List inference experiments | List |
| ListInferenceRecommendationsJobSteps | List inference recommendations job steps | List |
| ListInferenceRecommendationsJobs | List inference recommendations jobs | List |
| ListLabelingJobs | List labeling jobs | List |
| ListLabelingJobsForWorkteam | List labeling jobs for workteam | List |
| ListLineageGroups | List lineage groups | List |
| ListMlflowTrackingServers | List MLflow tracking servers | List |
| ListModelBiasJobDefinitions | List model bias job definitions | List |
| ListModelCardExportJobs | List export jobs for a model card | List |
| ListModelCardVersions | List versions of a model card | List |
| ListModelCards | List model cards | List |
| ListModelExplainabilityJobDefinitions | List model explainability job definitions | List |
| ListModelMetadata | List model metadata for inference recommendations jobs | List |
| ListModelPackageGroups | List ModelPackageGroups | List |
| ListModelPackages | List ModelPackages | List |
| ListModelQualityJobDefinitions | List model quality job definitions | List |
| ListModels | List the models created with the CreateModel API | List |
| ListMonitoringAlertHistory | List the history of a monitoring alert | List |
| ListMonitoringAlerts | List monitoring alerts | List |
| ListMonitoringExecutions | List monitoring executions | List |
| ListMonitoringSchedules | List monitoring schedules | List |
| ListNotebookInstanceLifecycleConfigs | List the notebook instance lifecycle configurations that can be deployed using Amazon SageMaker | List |
| ListNotebookInstances | List the Amazon SageMaker notebook instances in the requester's account in an AWS Region | List |
| ListOptimizationJobs | List optimization jobs | List |
| ListPartnerApps | List the Amazon SageMaker Partner AI Apps in your account | List |
| ListPipelineExecutionSteps | List steps for a pipeline execution | List |
| ListPipelineExecutions | List executions for a pipeline | List |
| ListPipelineParametersForExecution | List parameters for a pipeline execution | List |
| ListPipelineVersions | List versions of a pipeline | List |
| ListPipelines | List pipelines | List |
| ListProcessingJobs | List processing jobs | List |
| ListProjects | List Projects | List |
| ListResourceCatalogs | List resource catalogs | List |
| ListSharedModelEvents | List shared model events | List |
| ListSharedModelVersions | List shared model versions | List |
| ListSharedModels | List shared models | List |
| ListSpaces | List the Spaces in your account | List |
| ListStageDevices | List stage devices | List |
| ListStudioLifecycleConfigs | List the Studio Lifecycle Configurations that can be deployed using Amazon SageMaker | List |
| ListSubscribedWorkteams | List subscribed workteams | List |
| ListTags | List the tag set associated with the specified resource | List |
| ListTrainingJobs | List training jobs | List |
| ListTrainingJobsForHyperParameterTuningJob | List training jobs for a hyper parameter tuning job | List |
| ListTrainingPlans | List all the training plans that have been created in a specified account | List |
| ListTransformJobs | List transform jobs | List |
| ListTrialComponents | List trial components | List |
| ListTrials | List trials | List |
| ListUltraServersByReservedCapacity | List all UltraServers in a specified Reserved Capacity | List |
| ListUserProfiles | List the UserProfiles in your account | List |
| ListWorkforces | List workforces | List |
| ListWorkteams | List workteams | List |
| QueryLineage | Explore the lineage graph | List |
| RenderUiTemplate | Render a UI template used for a human annotation task | Read |
| Search | Search for SageMaker objects | Read |
| SearchTrainingPlanOfferings | Grants permissions to search for the available training plan offerings that best match specified capacity requirements | Read |
