SageMaker

Implementation details for API sagemaker

Coverage Overview

SageMaker is supported by LocalStack only in the pro image.

AvailabilityTesting*
OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
AddAssociation
AddTags✔️pro
AssociateTrialComponent✔️pro
BatchDescribeModelPackage
CreateAction
CreateAlgorithm
CreateApp
CreateAppImageConfig
CreateArtifact
CreateAutoMLJob
CreateAutoMLJobV2
CreateCluster
CreateCodeRepository
CreateCompilationJob
CreateContext
CreateDataQualityJobDefinition
CreateDeviceFleet
CreateDomain
CreateEdgeDeploymentPlan
CreateEdgeDeploymentStage
CreateEdgePackagingJob
CreateEndpoint✔️pro✔️✔️✔️Show Tests
CreateEndpointConfig✔️pro✔️✔️✔️Show Tests
CreateExperiment✔️pro✔️
CreateFeatureGroup✔️pro
CreateFlowDefinition
CreateHub
CreateHumanTaskUi
CreateHyperParameterTuningJob
CreateImage
CreateImageVersion
CreateInferenceComponent
CreateInferenceExperiment
CreateInferenceRecommendationsJob
CreateLabelingJob
CreateModel✔️pro✔️✔️✔️Show Tests
CreateModelBiasJobDefinition
CreateModelCard
CreateModelCardExportJob
CreateModelExplainabilityJobDefinition
CreateModelPackage✔️pro✔️
CreateModelPackageGroup✔️pro✔️
CreateModelQualityJobDefinition
CreateMonitoringSchedule
CreateNotebookInstance✔️pro✔️
CreateNotebookInstanceLifecycleConfig✔️pro
CreatePipeline✔️pro✔️✔️
CreatePresignedDomainUrl
CreatePresignedNotebookInstanceUrl
CreateProcessingJob✔️pro✔️
CreateProject
CreateSpace
CreateStudioLifecycleConfig
CreateTrainingJob✔️pro
CreateTransformJob✔️pro✔️
CreateTrial✔️pro✔️
CreateTrialComponent✔️pro✔️
CreateUserProfile
CreateWorkforce
CreateWorkteam
DeleteAction
DeleteAlgorithm
DeleteApp
DeleteAppImageConfig
DeleteArtifact
DeleteAssociation
DeleteCluster
DeleteCodeRepository
DeleteCompilationJob
DeleteContext
DeleteDataQualityJobDefinition
DeleteDeviceFleet
DeleteDomain
DeleteEdgeDeploymentPlan
DeleteEdgeDeploymentStage
DeleteEndpoint✔️pro✔️✔️✔️Show Tests
DeleteEndpointConfig✔️pro✔️✔️✔️Show Tests
DeleteExperiment✔️pro✔️
DeleteFeatureGroup
DeleteFlowDefinition
DeleteHub
DeleteHubContent
DeleteHumanTaskUi
DeleteHyperParameterTuningJob
DeleteImage
DeleteImageVersion
DeleteInferenceComponent
DeleteInferenceExperiment
DeleteModel✔️pro✔️✔️✔️Show Tests
DeleteModelBiasJobDefinition
DeleteModelCard
DeleteModelExplainabilityJobDefinition
DeleteModelPackage
DeleteModelPackageGroup
DeleteModelPackageGroupPolicy
DeleteModelQualityJobDefinition
DeleteMonitoringSchedule
DeleteNotebookInstance✔️pro
DeleteNotebookInstanceLifecycleConfig✔️pro
DeletePipeline✔️pro✔️✔️
DeleteProject
DeleteSpace
DeleteStudioLifecycleConfig
DeleteTags✔️pro
DeleteTrial✔️pro✔️
DeleteTrialComponent✔️pro✔️
DeleteUserProfile
DeleteWorkforce
DeleteWorkteam
DeregisterDevices
DescribeAction
DescribeAlgorithm
DescribeApp
DescribeAppImageConfig
DescribeArtifact
DescribeAutoMLJob
DescribeAutoMLJobV2
DescribeCluster
DescribeClusterNode
DescribeCodeRepository
DescribeCompilationJob
DescribeContext
DescribeDataQualityJobDefinition
DescribeDevice
DescribeDeviceFleet
DescribeDomain
DescribeEdgeDeploymentPlan
DescribeEdgePackagingJob
DescribeEndpoint✔️pro✔️✔️✔️Show Tests
DescribeEndpointConfig✔️pro✔️✔️✔️Show Tests
DescribeExperiment✔️pro
DescribeFeatureGroup✔️pro
DescribeFeatureMetadata
DescribeFlowDefinition
DescribeHub
DescribeHubContent
DescribeHumanTaskUi
DescribeHyperParameterTuningJob
DescribeImage
DescribeImageVersion
DescribeInferenceComponent
DescribeInferenceExperiment
DescribeInferenceRecommendationsJob
DescribeLabelingJob
DescribeLineageGroup
DescribeModel✔️pro✔️✔️✔️✔️Show Tests
DescribeModelBiasJobDefinition
DescribeModelCard
DescribeModelCardExportJob
DescribeModelExplainabilityJobDefinition
DescribeModelPackage✔️pro✔️
DescribeModelPackageGroup✔️pro
DescribeModelQualityJobDefinition
DescribeMonitoringSchedule
DescribeNotebookInstance✔️pro
DescribeNotebookInstanceLifecycleConfig✔️pro
DescribePipeline✔️pro✔️✔️
DescribePipelineDefinitionForExecution✔️pro✔️
DescribePipelineExecution✔️pro✔️
DescribeProcessingJob✔️pro✔️
DescribeProject
DescribeSpace
DescribeStudioLifecycleConfig
DescribeSubscribedWorkteam
DescribeTrainingJob✔️pro
DescribeTransformJob✔️pro✔️
DescribeTrial✔️pro
DescribeTrialComponent✔️pro✔️
DescribeUserProfile
DescribeWorkforce
DescribeWorkteam
DisableSagemakerServicecatalogPortfolio
DisassociateTrialComponent✔️pro
EnableSagemakerServicecatalogPortfolio
GetDeviceFleetReport
GetLineageGroupPolicy
GetModelPackageGroupPolicy
GetSagemakerServicecatalogPortfolioStatus
GetScalingConfigurationRecommendation
GetSearchSuggestions
ImportHubContent
ListActions
ListAlgorithms
ListAliases
ListAppImageConfigs
ListApps
ListArtifacts
ListAssociations
ListAutoMLJobs
ListCandidatesForAutoMLJob
ListClusterNodes
ListClusters
ListCodeRepositories
ListCompilationJobs
ListContexts
ListDataQualityJobDefinitions
ListDeviceFleets
ListDevices
ListDomains
ListEdgeDeploymentPlans
ListEdgePackagingJobs
ListEndpointConfigs✔️pro
ListEndpoints✔️pro
ListExperiments✔️pro✔️
ListFeatureGroups
ListFlowDefinitions
ListHubContentVersions
ListHubContents
ListHubs
ListHumanTaskUis
ListHyperParameterTuningJobs
ListImageVersions
ListImages
ListInferenceComponents
ListInferenceExperiments
ListInferenceRecommendationsJobSteps
ListInferenceRecommendationsJobs
ListLabelingJobs
ListLabelingJobsForWorkteam
ListLineageGroups
ListModelBiasJobDefinitions
ListModelCardExportJobs
ListModelCardVersions
ListModelCards
ListModelExplainabilityJobDefinitions
ListModelMetadata
ListModelPackageGroups✔️pro✔️
ListModelPackages✔️pro✔️
ListModelQualityJobDefinitions
ListModels✔️pro✔️
ListMonitoringAlertHistory
ListMonitoringAlerts
ListMonitoringExecutions
ListMonitoringSchedules
ListNotebookInstanceLifecycleConfigs
ListNotebookInstances✔️pro✔️
ListPipelineExecutionSteps
ListPipelineExecutions✔️pro✔️
ListPipelineParametersForExecution✔️pro✔️
ListPipelines✔️pro✔️
ListProcessingJobs✔️pro✔️
ListProjects
ListResourceCatalogs
ListSpaces
ListStageDevices
ListStudioLifecycleConfigs
ListSubscribedWorkteams
ListTags✔️pro✔️✔️
ListTrainingJobs✔️pro✔️
ListTrainingJobsForHyperParameterTuningJob
ListTransformJobs✔️pro✔️
ListTrialComponents✔️pro✔️
ListTrials✔️pro✔️
ListUserProfiles
ListWorkforces
ListWorkteams
PutModelPackageGroupPolicy
QueryLineage
RegisterDevices
RenderUiTemplate
RetryPipelineExecution
Search✔️pro
SendPipelineExecutionStepFailure
SendPipelineExecutionStepSuccess
StartEdgeDeploymentStage
StartInferenceExperiment
StartMonitoringSchedule
StartNotebookInstance✔️pro
StartPipelineExecution✔️pro✔️
StopAutoMLJob
StopCompilationJob
StopEdgeDeploymentStage
StopEdgePackagingJob
StopHyperParameterTuningJob
StopInferenceExperiment
StopInferenceRecommendationsJob
StopLabelingJob
StopMonitoringSchedule
StopNotebookInstance✔️pro✔️
StopPipelineExecution
StopProcessingJob
StopTrainingJob
StopTransformJob
UpdateAction
UpdateAppImageConfig
UpdateArtifact
UpdateCluster
UpdateClusterSoftware
UpdateCodeRepository
UpdateContext
UpdateDeviceFleet
UpdateDevices
UpdateDomain
UpdateEndpoint
UpdateEndpointWeightsAndCapacities✔️pro
UpdateExperiment
UpdateFeatureGroup
UpdateFeatureMetadata
UpdateHub
UpdateImage
UpdateImageVersion
UpdateInferenceComponent
UpdateInferenceComponentRuntimeConfig
UpdateInferenceExperiment
UpdateModelCard
UpdateModelPackage✔️pro✔️
UpdateMonitoringAlert
UpdateMonitoringSchedule
UpdateNotebookInstance
UpdateNotebookInstanceLifecycleConfig
UpdatePipeline✔️pro✔️
UpdatePipelineExecution
UpdateProject
UpdateSpace
UpdateTrainingJob
UpdateTrial
UpdateTrialComponent✔️pro✔️
UpdateUserProfile
UpdateWorkforce
UpdateWorkteam

Terminology

  • Internal Test Suite: tested by LocalStack's internal integration test suite
  • External Test Suite: covered by an external integration test suite, that runs against LocalStack
  • Terraform Validated: operation tested with Terraform
  • AWS Validated: the integration test that includes this operation call was validated against AWS
  • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

Testing Details

This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

How to read the test details?

For each operation we put up a list of the related integration test cases.
Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

  • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
  • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
    • test name
    • status code returned (which is the expected one for the test case)
    • information about validation:
      • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
      • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


CreateEndpoint

Parameters: EndpointConfigName, EndpointName
  • LocalStack Pro
    • test_custom_model_deployment LocalStack Pro: tests/aws/services/sagemaker/test_sagemaker.py::TestSagemaker::test_custom_model_deployment HTTP Status Code: 200 AWS validated Snapshot Tested

CreateEndpointConfig

Parameters: EndpointConfigName, ProductionVariants
  • LocalStack Pro
    • test_custom_model_deployment LocalStack Pro: tests/aws/services/sagemaker/test_sagemaker.py::TestSagemaker::test_custom_model_deployment HTTP Status Code: 200 AWS validated Snapshot Tested

CreateModel

Parameters: ExecutionRoleArn, ModelName, PrimaryContainer
  • LocalStack Pro
    • test_custom_model_deployment LocalStack Pro: tests/aws/services/sagemaker/test_sagemaker.py::TestSagemaker::test_custom_model_deployment HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteEndpoint

Parameters: EndpointName
  • LocalStack Pro
    • test_custom_model_deployment LocalStack Pro: tests/aws/services/sagemaker/test_sagemaker.py::TestSagemaker::test_custom_model_deployment HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteEndpointConfig

Parameters: EndpointConfigName
  • LocalStack Pro
    • test_custom_model_deployment LocalStack Pro: tests/aws/services/sagemaker/test_sagemaker.py::TestSagemaker::test_custom_model_deployment HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteModel

Parameters: ModelName
  • LocalStack Pro
    • test_custom_model_deployment LocalStack Pro: tests/aws/services/sagemaker/test_sagemaker.py::TestSagemaker::test_custom_model_deployment HTTP Status Code: 200 AWS validated Snapshot Tested

DescribeEndpoint

Parameters: EndpointName
  • LocalStack Pro
    • test_custom_model_deployment LocalStack Pro: tests/aws/services/sagemaker/test_sagemaker.py::TestSagemaker::test_custom_model_deployment HTTP Status Code: 200 AWS validated Snapshot Tested

DescribeEndpointConfig

Parameters: EndpointConfigName
  • LocalStack Pro
    • test_custom_model_deployment LocalStack Pro: tests/aws/services/sagemaker/test_sagemaker.py::TestSagemaker::test_custom_model_deployment HTTP Status Code: 200 AWS validated Snapshot Tested

DescribeModel

Parameters: ModelName
  • LocalStack Pro
    • test_custom_model_deployment LocalStack Pro: tests/aws/services/sagemaker/test_sagemaker.py::TestSagemaker::test_custom_model_deployment HTTP Status Code: 200 AWS validated Snapshot Tested

Last modified March 20, 2023: improve Coverage Docs (#505) (46f2fb0c0)