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


CreateDomain

Parameters: AuthMode, DefaultUserSettings, DomainName, SubnetIds, VpcId
  • LocalStack Pro
    • test_domain_user_profile_lifecycle LocalStack Pro: tests/aws/services/sagemaker/test_sagemaker.py::TestSagemaker::test_domain_user_profile_lifecycle HTTP Status Code: 200 AWS validated Snapshot Tested

CreateEndpoint

Parameters: EndpointConfigName, EndpointName
  • LocalStack Pro
    • test_stack_resources_are_deployed LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_stack_resources_are_deployed HTTP Status Code: 200 AWS validated Snapshot Tested
    • 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_stack_resources_are_deployed LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_stack_resources_are_deployed HTTP Status Code: 200 AWS validated Snapshot Tested
    • 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_stack_resources_are_deployed LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_stack_resources_are_deployed HTTP Status Code: 200 AWS validated Snapshot Tested
    • 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

CreateUserProfile

Parameters: DomainId, UserProfileName
  • LocalStack Pro
    • test_domain_user_profile_lifecycle LocalStack Pro: tests/aws/services/sagemaker/test_sagemaker.py::TestSagemaker::test_domain_user_profile_lifecycle HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteDomain

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

DeleteEndpoint

Parameters: EndpointName
  • LocalStack Pro
    • test_resource_deletion LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_resource_deletion HTTP Status Code: 200 AWS validated
    • 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_resource_deletion LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_resource_deletion HTTP Status Code: 200 AWS validated
    • 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_resource_deletion LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_resource_deletion HTTP Status Code: 200 AWS validated
    • 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

DeleteUserProfile

Parameters: DomainId, UserProfileName
  • LocalStack Pro
    • test_domain_user_profile_lifecycle LocalStack Pro: tests/aws/services/sagemaker/test_sagemaker.py::TestSagemaker::test_domain_user_profile_lifecycle HTTP Status Code: 200 AWS validated Snapshot Tested

DescribeDomain

Parameters: DomainId
  • LocalStack Pro
    • test_domain_user_profile_lifecycle LocalStack Pro: tests/aws/services/sagemaker/test_sagemaker.py::TestSagemaker::test_domain_user_profile_lifecycle HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_domain_user_profile_lifecycle LocalStack Pro: tests/aws/services/sagemaker/test_sagemaker.py::TestSagemaker::test_domain_user_profile_lifecycle HTTP Status Code: 400 (ResourceNotFound) AWS validated Snapshot Tested

DescribeEndpoint

Parameters: EndpointName
  • LocalStack Pro
    • test_endpoint_description LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_endpoint_description HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_stack_resources_are_deployed LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_stack_resources_are_deployed HTTP Status Code: 200 AWS validated Snapshot Tested
    • 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
    • test_resource_deletion LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_resource_deletion HTTP Status Code: 400 (ValidationException) AWS validated
    • test_resource_deletion LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_resource_deletion HTTP Status Code: 400 (ValidationException) AWS validated

DescribeEndpointConfig

Parameters: EndpointConfigName
  • LocalStack Pro
    • test_endpoint_config_description LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_endpoint_config_description HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_stack_resources_are_deployed LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_stack_resources_are_deployed HTTP Status Code: 200 AWS validated Snapshot Tested
    • 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
    • test_resource_deletion LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_resource_deletion HTTP Status Code: 400 (ValidationException) AWS validated
    • test_resource_deletion LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_resource_deletion HTTP Status Code: 400 (ValidationException) AWS validated

DescribeModel

Parameters: ModelName
  • LocalStack Pro
    • test_model_description LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_model_description HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_stack_resources_are_deployed LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_stack_resources_are_deployed HTTP Status Code: 200 AWS validated Snapshot Tested
    • 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
    • test_resource_deletion LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_resource_deletion HTTP Status Code: 400 (ValidationException) AWS validated
    • test_resource_deletion LocalStack Pro: tests/aws/services/cloudformation/resources/test_sagemaker.py::TestSageMakerEndpointStack::test_resource_deletion HTTP Status Code: 400 (ValidationException) AWS validated

DescribeUserProfile

Parameters: DomainId, UserProfileName
  • LocalStack Pro
    • test_domain_user_profile_lifecycle LocalStack Pro: tests/aws/services/sagemaker/test_sagemaker.py::TestSagemaker::test_domain_user_profile_lifecycle HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_domain_user_profile_lifecycle LocalStack Pro: tests/aws/services/sagemaker/test_sagemaker.py::TestSagemaker::test_domain_user_profile_lifecycle HTTP Status Code: 400 (ResourceNotFound) AWS validated Snapshot Tested

UpdateUserProfile

Parameters: DomainId, UserProfileName, UserSettings
  • LocalStack Pro
    • test_domain_user_profile_lifecycle LocalStack Pro: tests/aws/services/sagemaker/test_sagemaker.py::TestSagemaker::test_domain_user_profile_lifecycle HTTP Status Code: 200 AWS validated Snapshot Tested