Amazon SageMaker

(1)

Amazon SageMaker

Amazon Sagemaker API Reference

Amazon SageMaker: Amazon Sagemaker API Reference

(2)

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

Amazon SageMaker Service

Provides APIs for creating and managing SageMaker resources.

Other Resources:

• SageMaker Developer Guide

• Amazon Augmented AI Runtime API Reference

Amazon SageMaker Runtime

The Amazon SageMaker runtime API.

Amazon Sagemaker Edge Manager

SageMaker Edge Manager dataplane service for communicating with active agents.

Amazon SageMaker Feature Store Runtime

Contains all data plane API operations and data types for the Amazon SageMaker Feature Store. Use this API to put, delete, and retrieve (get) features from a feature store.

Use the following operations to conﬁgure your OnlineStore and OfflineStore features, and to create and manage feature groups:

• CreateFeatureGroup

• DeleteFeatureGroup

• DescribeFeatureGroup

• ListFeatureGroups

(16)

Actions

The following actions are supported by Amazon SageMaker Service:

• AddAssociation (p. 14)

• AddTags (p. 17)

• AssociateTrialComponent (p. 19)

• BatchDescribeModelPackage (p. 21)

• CreateAction (p. 24)

• CreateAlgorithm (p. 27)

• CreateApp (p. 32)

• CreateAppImageConﬁg (p. 35)

• CreateArtifact (p. 37)

• CreateAutoMLJob (p. 40)

• CreateCodeRepository (p. 44)

• CreateCompilationJob (p. 46)

• CreateContext (p. 50)

• CreateDataQualityJobDeﬁnition (p. 53)

• CreateDeviceFleet (p. 57)

• CreateDomain (p. 60)

• CreateEdgePackagingJob (p. 66)

• CreateEndpoint (p. 69)

• CreateEndpointConﬁg (p. 73)

• CreateExperiment (p. 77)

• CreateFeatureGroup (p. 80)

• CreateFlowDeﬁnition (p. 85)

• CreateHumanTaskUi (p. 88)

• CreateHyperParameterTuningJob (p. 90)

• CreateImage (p. 97)

• CreateImageVersion (p. 100)

• CreateInferenceRecommendationsJob (p. 103)

• CreateLabelingJob (p. 107)

• CreateModel (p. 113)

• CreateModelBiasJobDeﬁnition (p. 117)

• CreateModelExplainabilityJobDeﬁnition (p. 121)

• CreateModelPackage (p. 125)

• CreateModelPackageGroup (p. 134)

• CreateModelQualityJobDeﬁnition (p. 136)

• CreateMonitoringSchedule (p. 140)

• CreateNotebookInstance (p. 144)

• CreateNotebookInstanceLifecycleConﬁg (p. 150)

• CreatePipeline (p. 153)

• CreatePresignedDomainUrl (p. 157)

(17)

• CreatePresignedNotebookInstanceUrl (p. 160)

• CreateProcessingJob (p. 162)

• CreateProject (p. 167)

• CreateStudioLifecycleConﬁg (p. 170)

• CreateTrainingJob (p. 173)

• CreateTransformJob (p. 182)

• CreateTrial (p. 188)

• CreateTrialComponent (p. 191)

• CreateUserProﬁle (p. 195)

• CreateWorkforce (p. 199)

• CreateWorkteam (p. 202)

• DeleteAction (p. 205)

• DeleteAlgorithm (p. 207)

• DeleteApp (p. 208)

• DeleteAppImageConﬁg (p. 210)

• DeleteArtifact (p. 212)

• DeleteAssociation (p. 214)

• DeleteCodeRepository (p. 216)

• DeleteContext (p. 217)

• DeleteDataQualityJobDeﬁnition (p. 219)

• DeleteDeviceFleet (p. 221)

• DeleteDomain (p. 223)

• DeleteEndpoint (p. 225)

• DeleteEndpointConﬁg (p. 227)

• DeleteExperiment (p. 229)

• DeleteFeatureGroup (p. 231)

• DeleteFlowDeﬁnition (p. 233)

• DeleteHumanTaskUi (p. 235)

• DeleteImage (p. 237)

• DeleteImageVersion (p. 239)

• DeleteModel (p. 241)

• DeleteModelBiasJobDeﬁnition (p. 243)

• DeleteModelExplainabilityJobDeﬁnition (p. 245)

• DeleteModelPackage (p. 247)

• DeleteModelPackageGroup (p. 249)

• DeleteModelPackageGroupPolicy (p. 251)

• DeleteModelQualityJobDeﬁnition (p. 252)

• DeleteMonitoringSchedule (p. 254)

• DeleteNotebookInstance (p. 256)

• DeleteNotebookInstanceLifecycleConﬁg (p. 258)

• DeletePipeline (p. 259)

• DeleteProject (p. 261)

• DeleteStudioLifecycleConﬁg (p. 263)

• DeleteTags (p. 265)

• DeleteTrial (p. 267)

(18)

• DeleteTrialComponent (p. 269)

• DeleteUserProﬁle (p. 271)

• DeleteWorkforce (p. 273)

• DeleteWorkteam (p. 275)

• DeregisterDevices (p. 277)

• DescribeAction (p. 279)

• DescribeAlgorithm (p. 283)

• DescribeApp (p. 289)

• DescribeAppImageConﬁg (p. 293)

• DescribeArtifact (p. 296)

• DescribeAutoMLJob (p. 300)

• DescribeCodeRepository (p. 306)

• DescribeCompilationJob (p. 308)

• DescribeContext (p. 313)

• DescribeDataQualityJobDeﬁnition (p. 317)

• DescribeDevice (p. 321)

• DescribeDeviceFleet (p. 325)

• DescribeDomain (p. 328)

• DescribeEdgePackagingJob (p. 334)

• DescribeEndpoint (p. 338)

• DescribeEndpointConﬁg (p. 343)

• DescribeExperiment (p. 346)

• DescribeFeatureGroup (p. 349)

• DescribeFlowDeﬁnition (p. 354)

• DescribeHumanTaskUi (p. 357)

• DescribeHyperParameterTuningJob (p. 359)

• DescribeImage (p. 367)

• DescribeImageVersion (p. 370)

• DescribeInferenceRecommendationsJob (p. 373)

• DescribeLabelingJob (p. 377)

• DescribeLineageGroup (p. 383)

• DescribeModel (p. 386)

• DescribeModelBiasJobDeﬁnition (p. 389)

• DescribeModelExplainabilityJobDeﬁnition (p. 393)

• DescribeModelPackage (p. 397)

• DescribeModelPackageGroup (p. 405)

• DescribeModelQualityJobDeﬁnition (p. 408)

• DescribeMonitoringSchedule (p. 412)

• DescribeNotebookInstance (p. 416)

• DescribeNotebookInstanceLifecycleConﬁg (p. 421)

• DescribePipeline (p. 424)

• DescribePipelineDeﬁnitionForExecution (p. 428)

• DescribePipelineExecution (p. 430)

• DescribeProcessingJob (p. 434)

• DescribeProject (p. 440)

(19)

• DescribeStudioLifecycleConﬁg (p. 443)

• DescribeSubscribedWorkteam (p. 446)

• DescribeTrainingJob (p. 448)

• DescribeTransformJob (p. 459)

• DescribeTrial (p. 464)

• DescribeTrialComponent (p. 467)

• DescribeUserProﬁle (p. 472)

• DescribeWorkforce (p. 476)

• DescribeWorkteam (p. 478)

• DisableSagemakerServicecatalogPortfolio (p. 480)

• DisassociateTrialComponent (p. 481)

• EnableSagemakerServicecatalogPortfolio (p. 483)

• GetDeviceFleetReport (p. 484)

• GetLineageGroupPolicy (p. 487)

• GetModelPackageGroupPolicy (p. 489)

• GetSagemakerServicecatalogPortfolioStatus (p. 491)

• GetSearchSuggestions (p. 492)

• ListActions (p. 494)

• ListAlgorithms (p. 497)

• ListAppImageConﬁgs (p. 500)

• ListApps (p. 503)

• ListArtifacts (p. 506)

• ListAssociations (p. 509)

• ListAutoMLJobs (p. 513)

• ListCandidatesForAutoMLJob (p. 517)

• ListCodeRepositories (p. 521)

• ListCompilationJobs (p. 525)

• ListContexts (p. 529)

• ListDataQualityJobDeﬁnitions (p. 532)

• ListDeviceFleets (p. 535)

• ListDevices (p. 538)

• ListDomains (p. 541)

• ListEdgePackagingJobs (p. 543)

• ListEndpointConﬁgs (p. 547)

• ListEndpoints (p. 550)

• ListExperiments (p. 553)

• ListFeatureGroups (p. 556)

• ListFlowDeﬁnitions (p. 559)

• ListHumanTaskUis (p. 562)

• ListHyperParameterTuningJobs (p. 565)

• ListImages (p. 569)

• ListImageVersions (p. 572)

• ListInferenceRecommendationsJobs (p. 575)

• ListLabelingJobs (p. 578)

• ListLabelingJobsForWorkteam (p. 582)

• ListLineageGroups (p. 585)

(20)

• ListModelBiasJobDeﬁnitions (p. 588)

• ListModelExplainabilityJobDeﬁnitions (p. 591)

• ListModelMetadata (p. 594)

• ListModelPackageGroups (p. 596)

• ListModelPackages (p. 599)

• ListModelQualityJobDeﬁnitions (p. 603)

• ListModels (p. 606)

• ListMonitoringExecutions (p. 609)

• ListMonitoringSchedules (p. 613)

• ListNotebookInstanceLifecycleConﬁgs (p. 617)

• ListNotebookInstances (p. 620)

• ListPipelineExecutions (p. 624)

• ListPipelineExecutionSteps (p. 627)

• ListPipelineParametersForExecution (p. 631)

• ListPipelines (p. 634)

• ListProcessingJobs (p. 637)

• ListProjects (p. 640)

• ListStudioLifecycleConﬁgs (p. 643)

• ListSubscribedWorkteams (p. 647)

• ListTags (p. 649)

• ListTrainingJobs (p. 651)

• ListTrainingJobsForHyperParameterTuningJob (p. 655)

• ListTransformJobs (p. 658)

• ListTrialComponents (p. 661)

• ListTrials (p. 665)

• ListUserProﬁles (p. 668)

• ListWorkforces (p. 671)

• ListWorkteams (p. 674)

• PutModelPackageGroupPolicy (p. 677)

• QueryLineage (p. 679)

• RegisterDevices (p. 683)

• RenderUiTemplate (p. 685)

• RetryPipelineExecution (p. 688)

• Search (p. 691)

• SendPipelineExecutionStepFailure (p. 713)

• SendPipelineExecutionStepSuccess (p. 715)

• StartMonitoringSchedule (p. 717)

• StartNotebookInstance (p. 719)

• StartPipelineExecution (p. 721)

• StopAutoMLJob (p. 724)

• StopCompilationJob (p. 726)

• StopEdgePackagingJob (p. 728)

• StopHyperParameterTuningJob (p. 729)

• StopInferenceRecommendationsJob (p. 731)

• StopLabelingJob (p. 733)

• StopMonitoringSchedule (p. 735)

(21)

• StopNotebookInstance (p. 737)

• StopPipelineExecution (p. 739)

• StopProcessingJob (p. 741)

• StopTrainingJob (p. 743)

• StopTransformJob (p. 745)

• UpdateAction (p. 747)

• UpdateAppImageConﬁg (p. 750)

• UpdateArtifact (p. 752)

• UpdateCodeRepository (p. 755)

• UpdateContext (p. 757)

• UpdateDeviceFleet (p. 760)

• UpdateDevices (p. 762)

• UpdateDomain (p. 764)

• UpdateEndpoint (p. 767)

• UpdateEndpointWeightsAndCapacities (p. 771)

• UpdateExperiment (p. 773)

• UpdateImage (p. 775)

• UpdateModelPackage (p. 778)

• UpdateMonitoringSchedule (p. 781)

• UpdateNotebookInstance (p. 784)

• UpdateNotebookInstanceLifecycleConﬁg (p. 788)

• UpdatePipeline (p. 790)

• UpdatePipelineExecution (p. 793)

• UpdateProject (p. 796)

• UpdateTrainingJob (p. 799)

• UpdateTrial (p. 801)

• UpdateTrialComponent (p. 803)

• UpdateUserProﬁle (p. 807)

• UpdateWorkforce (p. 810)

• UpdateWorkteam (p. 813)

The following actions are supported by Amazon SageMaker Runtime:

• InvokeEndpoint (p. 816)

• InvokeEndpointAsync (p. 822)

The following actions are supported by Amazon Sagemaker Edge Manager:

• GetDeviceRegistration (p. 826)

• SendHeartbeat (p. 828)

The following actions are supported by Amazon SageMaker Feature Store Runtime:

• BatchGetRecord (p. 831)

• DeleteRecord (p. 834)

• GetRecord (p. 836)

• PutRecord (p. 839)

(22)

Amazon SageMaker Service

The following actions are supported by Amazon SageMaker Service:

• AddAssociation (p. 14)

• AddTags (p. 17)

• AssociateTrialComponent (p. 19)

• BatchDescribeModelPackage (p. 21)

• CreateAction (p. 24)

• CreateAlgorithm (p. 27)

• CreateApp (p. 32)

• CreateAppImageConﬁg (p. 35)

• CreateArtifact (p. 37)

• CreateAutoMLJob (p. 40)

• CreateCodeRepository (p. 44)

• CreateCompilationJob (p. 46)

• CreateContext (p. 50)

• CreateDataQualityJobDeﬁnition (p. 53)

• CreateDeviceFleet (p. 57)

• CreateDomain (p. 60)

• CreateEdgePackagingJob (p. 66)

• CreateEndpoint (p. 69)

• CreateEndpointConﬁg (p. 73)

• CreateExperiment (p. 77)

• CreateFeatureGroup (p. 80)

• CreateFlowDeﬁnition (p. 85)

• CreateHumanTaskUi (p. 88)

• CreateHyperParameterTuningJob (p. 90)

• CreateImage (p. 97)

• CreateImageVersion (p. 100)

• CreateInferenceRecommendationsJob (p. 103)

• CreateLabelingJob (p. 107)

• CreateModel (p. 113)

• CreateModelBiasJobDeﬁnition (p. 117)

• CreateModelExplainabilityJobDeﬁnition (p. 121)

• CreateModelPackage (p. 125)

• CreateModelPackageGroup (p. 134)

• CreateModelQualityJobDeﬁnition (p. 136)

• CreateMonitoringSchedule (p. 140)

• CreateNotebookInstance (p. 144)

• CreateNotebookInstanceLifecycleConﬁg (p. 150)

• CreatePipeline (p. 153)

• CreatePresignedDomainUrl (p. 157)

• CreatePresignedNotebookInstanceUrl (p. 160)

• CreateProcessingJob (p. 162)

• CreateProject (p. 167)

(23)

• CreateStudioLifecycleConﬁg (p. 170)

• CreateTrainingJob (p. 173)

• CreateTransformJob (p. 182)

• CreateTrial (p. 188)

• CreateTrialComponent (p. 191)

• CreateUserProﬁle (p. 195)

• CreateWorkforce (p. 199)

• CreateWorkteam (p. 202)

• DeleteAction (p. 205)

• DeleteAlgorithm (p. 207)

• DeleteApp (p. 208)

• DeleteAppImageConﬁg (p. 210)

• DeleteArtifact (p. 212)

• DeleteAssociation (p. 214)

• DeleteCodeRepository (p. 216)

• DeleteContext (p. 217)

• DeleteDataQualityJobDeﬁnition (p. 219)

• DeleteDeviceFleet (p. 221)

• DeleteDomain (p. 223)

• DeleteEndpoint (p. 225)

• DeleteEndpointConﬁg (p. 227)

• DeleteExperiment (p. 229)

• DeleteFeatureGroup (p. 231)

• DeleteFlowDeﬁnition (p. 233)

• DeleteHumanTaskUi (p. 235)

• DeleteImage (p. 237)

• DeleteImageVersion (p. 239)

• DeleteModel (p. 241)

• DeleteModelBiasJobDeﬁnition (p. 243)

• DeleteModelExplainabilityJobDeﬁnition (p. 245)

• DeleteModelPackage (p. 247)

• DeleteModelPackageGroup (p. 249)

• DeleteModelPackageGroupPolicy (p. 251)

• DeleteModelQualityJobDeﬁnition (p. 252)

• DeleteMonitoringSchedule (p. 254)

• DeleteNotebookInstance (p. 256)

• DeleteNotebookInstanceLifecycleConﬁg (p. 258)

• DeletePipeline (p. 259)

• DeleteProject (p. 261)

• DeleteStudioLifecycleConﬁg (p. 263)

• DeleteTags (p. 265)

• DeleteTrial (p. 267)

• DeleteTrialComponent (p. 269)

• DeleteUserProﬁle (p. 271)

• DeleteWorkforce (p. 273)

• DeleteWorkteam (p. 275)

(24)

• DeregisterDevices (p. 277)

• DescribeAction (p. 279)

• DescribeAlgorithm (p. 283)

• DescribeApp (p. 289)

• DescribeAppImageConﬁg (p. 293)

• DescribeArtifact (p. 296)

• DescribeAutoMLJob (p. 300)

• DescribeCodeRepository (p. 306)

• DescribeCompilationJob (p. 308)

• DescribeContext (p. 313)

• DescribeDataQualityJobDeﬁnition (p. 317)

• DescribeDevice (p. 321)

• DescribeDeviceFleet (p. 325)

• DescribeDomain (p. 328)

• DescribeEdgePackagingJob (p. 334)

• DescribeEndpoint (p. 338)

• DescribeEndpointConﬁg (p. 343)

• DescribeExperiment (p. 346)

• DescribeFeatureGroup (p. 349)

• DescribeFlowDeﬁnition (p. 354)

• DescribeHumanTaskUi (p. 357)

• DescribeHyperParameterTuningJob (p. 359)

• DescribeImage (p. 367)

• DescribeImageVersion (p. 370)

• DescribeInferenceRecommendationsJob (p. 373)

• DescribeLabelingJob (p. 377)

• DescribeLineageGroup (p. 383)

• DescribeModel (p. 386)

• DescribeModelBiasJobDeﬁnition (p. 389)

• DescribeModelExplainabilityJobDeﬁnition (p. 393)

• DescribeModelPackage (p. 397)

• DescribeModelPackageGroup (p. 405)

• DescribeModelQualityJobDeﬁnition (p. 408)

• DescribeMonitoringSchedule (p. 412)

• DescribeNotebookInstance (p. 416)

• DescribeNotebookInstanceLifecycleConﬁg (p. 421)

• DescribePipeline (p. 424)

• DescribePipelineDeﬁnitionForExecution (p. 428)

• DescribePipelineExecution (p. 430)

• DescribeProcessingJob (p. 434)

• DescribeProject (p. 440)

• DescribeStudioLifecycleConﬁg (p. 443)

• DescribeSubscribedWorkteam (p. 446)

• DescribeTrainingJob (p. 448)

• DescribeTransformJob (p. 459)

• DescribeTrial (p. 464)

(25)

• DescribeTrialComponent (p. 467)

• DescribeUserProﬁle (p. 472)

• DescribeWorkforce (p. 476)

• DescribeWorkteam (p. 478)

• DisableSagemakerServicecatalogPortfolio (p. 480)

• DisassociateTrialComponent (p. 481)

• EnableSagemakerServicecatalogPortfolio (p. 483)

• GetDeviceFleetReport (p. 484)

• GetLineageGroupPolicy (p. 487)

• GetModelPackageGroupPolicy (p. 489)

• GetSagemakerServicecatalogPortfolioStatus (p. 491)

• GetSearchSuggestions (p. 492)

• ListActions (p. 494)

• ListAlgorithms (p. 497)

• ListAppImageConﬁgs (p. 500)

• ListApps (p. 503)

• ListArtifacts (p. 506)

• ListAssociations (p. 509)

• ListAutoMLJobs (p. 513)

• ListCandidatesForAutoMLJob (p. 517)

• ListCodeRepositories (p. 521)

• ListCompilationJobs (p. 525)

• ListContexts (p. 529)

• ListDataQualityJobDeﬁnitions (p. 532)

• ListDeviceFleets (p. 535)

• ListDevices (p. 538)

• ListDomains (p. 541)

• ListEdgePackagingJobs (p. 543)

• ListEndpointConﬁgs (p. 547)

• ListEndpoints (p. 550)

• ListExperiments (p. 553)

• ListFeatureGroups (p. 556)

• ListFlowDeﬁnitions (p. 559)

• ListHumanTaskUis (p. 562)

• ListHyperParameterTuningJobs (p. 565)

• ListImages (p. 569)

• ListImageVersions (p. 572)

• ListInferenceRecommendationsJobs (p. 575)

• ListLabelingJobs (p. 578)

• ListLabelingJobsForWorkteam (p. 582)

• ListLineageGroups (p. 585)

• ListModelBiasJobDeﬁnitions (p. 588)

• ListModelExplainabilityJobDeﬁnitions (p. 591)

• ListModelMetadata (p. 594)

• ListModelPackageGroups (p. 596)

• ListModelPackages (p. 599)

(26)

• ListModelQualityJobDeﬁnitions (p. 603)

• ListModels (p. 606)

• ListMonitoringExecutions (p. 609)

• ListMonitoringSchedules (p. 613)

• ListNotebookInstanceLifecycleConﬁgs (p. 617)

• ListNotebookInstances (p. 620)

• ListPipelineExecutions (p. 624)

• ListPipelineExecutionSteps (p. 627)

• ListPipelineParametersForExecution (p. 631)

• ListPipelines (p. 634)

• ListProcessingJobs (p. 637)

• ListProjects (p. 640)

• ListStudioLifecycleConﬁgs (p. 643)

• ListSubscribedWorkteams (p. 647)

• ListTags (p. 649)

• ListTrainingJobs (p. 651)

• ListTrainingJobsForHyperParameterTuningJob (p. 655)

• ListTransformJobs (p. 658)

• ListTrialComponents (p. 661)

• ListTrials (p. 665)

• ListUserProﬁles (p. 668)

• ListWorkforces (p. 671)

• ListWorkteams (p. 674)

• PutModelPackageGroupPolicy (p. 677)

• QueryLineage (p. 679)

• RegisterDevices (p. 683)

• RenderUiTemplate (p. 685)

• RetryPipelineExecution (p. 688)

• Search (p. 691)

• SendPipelineExecutionStepFailure (p. 713)

• SendPipelineExecutionStepSuccess (p. 715)

• StartMonitoringSchedule (p. 717)

• StartNotebookInstance (p. 719)

• StartPipelineExecution (p. 721)

• StopAutoMLJob (p. 724)

• StopCompilationJob (p. 726)

• StopEdgePackagingJob (p. 728)

• StopHyperParameterTuningJob (p. 729)

• StopInferenceRecommendationsJob (p. 731)

• StopLabelingJob (p. 733)

• StopMonitoringSchedule (p. 735)

• StopNotebookInstance (p. 737)

• StopPipelineExecution (p. 739)

• StopProcessingJob (p. 741)

• StopTrainingJob (p. 743)

• StopTransformJob (p. 745)

(27)

• UpdateAction (p. 747)

• UpdateAppImageConﬁg (p. 750)

• UpdateArtifact (p. 752)

• UpdateCodeRepository (p. 755)

• UpdateContext (p. 757)

• UpdateDeviceFleet (p. 760)

• UpdateDevices (p. 762)

• UpdateDomain (p. 764)

• UpdateEndpoint (p. 767)

• UpdateEndpointWeightsAndCapacities (p. 771)

• UpdateExperiment (p. 773)

• UpdateImage (p. 775)

• UpdateModelPackage (p. 778)

• UpdateMonitoringSchedule (p. 781)

• UpdateNotebookInstance (p. 784)

• UpdateNotebookInstanceLifecycleConﬁg (p. 788)

• UpdatePipeline (p. 790)

• UpdatePipelineExecution (p. 793)

• UpdateProject (p. 796)

• UpdateTrainingJob (p. 799)

• UpdateTrial (p. 801)

• UpdateTrialComponent (p. 803)

• UpdateUserProﬁle (p. 807)

• UpdateWorkforce (p. 810)

• UpdateWorkteam (p. 813)

(28)

AddAssociation

Service: Amazon SageMaker Service

Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.

Request Syntax

{ "AssociationType": "string", "DestinationArn": "string", "SourceArn": "string"

}

Request Parameters

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

The request accepts the following data in JSON format.

AssociationType (p. 14)

The type of association. The following are suggested uses for each type. Amazon SageMaker places no restrictions on their use.

• ContributedTo - The source contributed to the destination or had a part in enabling the destination. For example, the training data contributed to the training job.

• AssociatedWith - The source is connected to the destination. For example, an approval workﬂow is associated with a model deployment.

• DerivedFrom - The destination is a modiﬁcation of the source. For example, a digest output of a channel input for a processing job is derived from the original inputs.

• Produced - The source generated the destination. For example, a training job produced a model artifact.

Type: String

Valid Values: ContributedTo | AssociatedWith | DerivedFrom | Produced Required: No

DestinationArn (p. 14)

The Amazon Resource Name (ARN) of the destination.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|

experiment-trial-component|artifact|action|context)/.*

Required: Yes SourceArn (p. 14)

The ARN of the source.

Type: String

(29)

AddAssociation

Required: Yes

Response Syntax

{ "DestinationArn": "string", "SourceArn": "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.

DestinationArn (p. 15)

The Amazon Resource Name (ARN) of the destination.

Type: String

SourceArn (p. 15)

The ARN of the source.

Type: String

Errors

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

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400 ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

(30)

AddAssociation

AddTags

Adds or overwrites one or more tags for the speciﬁed SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint conﬁgurations, and endpoints.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see AWS Tagging Strategies.

NoteTags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob (p. 90) NoteTags that you add to a SageMaker Studio Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain (p. 60) or CreateUserProfile (p. 195).

Request Syntax

{ "ResourceArn": "string", "Tags": [

{

"Key": "string", "Value": "string"

} ]}

Request Parameters

ResourceArn (p. 17)

The Amazon Resource Name (ARN) of the resource that you want to tag.

Type: String

Pattern: arn:aws[a-z-]*:sagemaker:[a-z0-9-]*:[0-9]{12}:.+

Required: Yes Tags (p. 17)

An array of key-value pairs. You can use tags to categorize your AWS resources in diﬀerent ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.

(32)

AddTags

Type: Array of Tag (p. 1370) objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: Yes

Response Syntax

{ "Tags": [ {

} ] }

Response Elements

Tags (p. 18)

A list of tags associated with the SageMaker resource.

Errors

AssociateTrialComponent

Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent (p. 481) API.

Request Syntax

{ "TrialComponentName": "string", "TrialName": "string"

}

Request Parameters

TrialComponentName (p. 19)

The name of the component to associated with the trial.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}

Required: Yes TrialName (p. 19)

The name of the trial to associate with.

Type: String

Required: Yes

Response Syntax

{ "TrialArn": "string",

"TrialComponentArn": "string"

}

Response Elements

(34)

AssociateTrialComponent

TrialArn (p. 19)

The Amazon Resource Name (ARN) of the trial.

Type: String

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment-trial/.*

TrialComponentArn (p. 19)

The ARN of the trial component.

Type: String

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment-trial- component/.*

Errors

HTTP Status Code: 400 ResourceNotFound

Resource being access is not found.

BatchDescribeModelPackage

This action batch describes a list of versioned model packages

Request Syntax

{ "ModelPackageArnList": [ "string" ] }

Request Parameters

ModelPackageArnList (p. 21)

The list of Amazon Resource Name (ARN) of the model package groups.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:model-package/.*

Required: Yes

Response Syntax

{ "BatchDescribeModelPackageErrorMap": { "string" : {

"ErrorCode": "string", "ErrorResponse": "string"

} },

"ModelPackageSummaries": { "string" : {

"CreationTime": number, "InferenceSpecification": { "Containers": [

{

"ContainerHostname": "string", "Environment": {

"string" : "string"

},

"Framework": "string",

"FrameworkVersion": "string", "Image": "string",

"ImageDigest": "string", "ModelDataUrl": "string", "ModelInput": {

"DataInputConfig": "string"

(36)

},

"NearestModelName": "string", "ProductId": "string"

} ],

"SupportedContentTypes": [ "string" ],

"SupportedRealtimeInferenceInstanceTypes": [ "string" ], "SupportedResponseMIMETypes": [ "string" ],

"SupportedTransformInstanceTypes": [ "string" ] },

"ModelApprovalStatus": "string", "ModelPackageArn": "string",

"ModelPackageDescription": "string", "ModelPackageGroupName": "string", "ModelPackageStatus": "string", "ModelPackageVersion": number }

}}

Response Elements

BatchDescribeModelPackageErrorMap (p. 21)

A map of the resource and BatchDescribeModelPackageError objects reporting the error associated with describing the model package.

Type: String to BatchDescribeModelPackageError (p. 921) object map Key Length Constraints: Minimum length of 1. Maximum length of 2048.

Key Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:model-package/.*

ModelPackageSummaries (p. 21)

The summaries for the model package versions

Type: String to BatchDescribeModelPackageSummary (p. 922) object map Key Length Constraints: Minimum length of 1. Maximum length of 2048.

Key Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:model-package/.*

Errors

CreateAction

Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact.

For more information, see Amazon SageMaker ML Lineage Tracking.

Request Syntax

{

"ActionName": "string", "ActionType": "string", "Description": "string", "MetadataProperties": { "CommitId": "string", "GeneratedBy": "string", "ProjectId": "string", "Repository": "string"

},

"Properties": { "string" : "string"

},

"Source": {

"SourceId": "string", "SourceType": "string", "SourceUri": "string"

},

"Status": "string", "Tags": [

{

} ]}

Request Parameters

ActionName (p. 24)

The name of the action. Must be unique to your account in an AWS Region.

Type: String

Required: Yes ActionType (p. 24)

The action type.

Type: String

(39)

CreateAction

Required: Yes Description (p. 24)

The description of the action.

Type: String

Pattern: .*

Required: No

MetadataProperties (p. 24)

Metadata properties of the tracking entity, trial, or trial component.

Type: MetadataProperties (p. 1137) object Required: No

Properties (p. 24)

A list of properties to add to the action.

Type: String to string map

Map Entries: Maximum number of 30 items.

Key Length Constraints: Maximum length of 256.

Key Pattern: .*

Value Length Constraints: Maximum length of 256.

Value Pattern: .*

Required: No Source (p. 24)

The source type, ID, and URI.

Type: ActionSource (p. 859) object Required: Yes

Status (p. 24)

The status of the action.

Type: String

Tags (p. 24)

A list of tags to apply to the action.

(40)

CreateAction

Required: No

Response Syntax

{ "ActionArn": "string"

}

Response Elements

ActionArn (p. 26)

The Amazon Resource Name (ARN) of the action.

Type: String

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:action/.*

Errors

CreateAlgorithm

Create a machine learning algorithm that you can use in SageMaker and list in the AWS Marketplace.

Request Syntax

{

"AlgorithmDescription": "string", "AlgorithmName": "string",

"CertifyForMarketplace": boolean, "InferenceSpecification": { "Containers": [

{

"ContainerHostname": "string", "Environment": {

"string" : "string"

},

"Framework": "string", "FrameworkVersion": "string", "Image": "string",

"ImageDigest": "string", "ModelDataUrl": "string", "ModelInput": {

"DataInputConfig": "string"

},

"NearestModelName": "string", "ProductId": "string"

} ],

"SupportedContentTypes": [ "string" ],

"SupportedRealtimeInferenceInstanceTypes": [ "string" ], "SupportedResponseMIMETypes": [ "string" ],

"SupportedTransformInstanceTypes": [ "string" ] },

"Tags": [ {

} ],

"TrainingSpecification": { "MetricDefinitions": [ {

"Name": "string", "Regex": "string"

} ],

"SupportedHyperParameters": [ {

"DefaultValue": "string", "Description": "string", "IsRequired": boolean, "IsTunable": boolean, "Name": "string", "Range": {

"CategoricalParameterRangeSpecification": { "Values": [ "string" ]

},

"ContinuousParameterRangeSpecification": { "MaxValue": "string",

"MinValue": "string"

},

(42)

CreateAlgorithm

"IntegerParameterRangeSpecification": { "MaxValue": "string",

"MinValue": "string"

} },

"Type": "string"

} ],

"SupportedTrainingInstanceTypes": [ "string" ], "SupportedTuningJobObjectiveMetrics": [ {

"MetricName": "string", "Type": "string"

} ],

"SupportsDistributedTraining": boolean, "TrainingChannels": [

{

"Description": "string", "IsRequired": boolean, "Name": "string",

"SupportedCompressionTypes": [ "string" ], "SupportedContentTypes": [ "string" ], "SupportedInputModes": [ "string" ] }

],

"TrainingImage": "string", "TrainingImageDigest": "string"

},

"ValidationSpecification": { "ValidationProfiles": [ {

"ProfileName": "string", "TrainingJobDefinition": { "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 }

} ],

"OutputDataConfig": { "KmsKeyId": "string", "S3OutputPath": "string"

(43)

CreateAlgorithm

},

"ResourceConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number },

"StoppingCondition": {

"MaxRuntimeInSeconds": number, "MaxWaitTimeInSeconds": number },

"TrainingInputMode": "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"

}}

Request Parameters

AlgorithmDescription (p. 27)

A description of the algorithm.

Type: String

Amazon SageMaker

Amazon SageMaker

Amazon Sagemaker API Reference

Amazon SageMaker: Amazon Sagemaker API Reference

Table of Contents

Welcome

Amazon SageMaker Service

Amazon SageMaker Runtime

Amazon Sagemaker Edge Manager

Amazon SageMaker Feature Store Runtime

Actions

Amazon SageMaker Service

AddAssociation

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

AddTags

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

AssociateTrialComponent

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

BatchDescribeModelPackage

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

CreateAction

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

CreateAlgorithm

Request Syntax

Request Parameters