docs.aws.amazon.com Open in urlscan Pro
18.239.36.53  Public Scan

Form analysis
0 forms found in the DOM

Text Content

SELECT YOUR COOKIE PREFERENCES

We use essential cookies and similar tools that are necessary to provide our
site and services. We use performance cookies to collect anonymous statistics so
we can understand how customers use our site and make improvements. Essential
cookies cannot be deactivated, but you can click “Customize cookies” to decline
performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide
useful site features, remember your preferences, and display relevant content,
including relevant advertising. To continue without accepting these cookies,
click “Continue without accepting.” To make more detailed choices or learn more,
click “Customize cookies.”

Accept all cookiesContinue without acceptingCustomize cookies


CUSTOMIZE COOKIE PREFERENCES

We use cookies and similar tools (collectively, "cookies") for the following
purposes.


ESSENTIAL

Essential cookies are necessary to provide our site and services and cannot be
deactivated. They are usually set in response to your actions on the site, such
as setting your privacy preferences, signing in, or filling in forms.




PERFORMANCE

Performance cookies provide anonymous statistics about how customers navigate
our site so we can improve site experience and performance. Approved third
parties may perform analytics on our behalf, but they cannot use the data for
their own purposes.

Allow performance category
Allowed


FUNCTIONAL

Functional cookies help us provide useful site features, remember your
preferences, and display relevant content. Approved third parties may set these
cookies to provide certain site features. If you do not allow these cookies,
then some or all of these services may not function properly.

Allow functional category
Allowed


ADVERTISING

Advertising cookies may be set through our site by us or our advertising
partners and help us deliver relevant marketing content. If you do not allow
these cookies, you will experience less relevant advertising.

Allow advertising category
Allowed

Blocking some types of cookies may impact your experience of our sites. You may
review and change your choices at any time by clicking Cookie preferences in the
footer of this site. We and selected third-parties use cookies or similar
technologies as specified in the AWS Cookie Notice.

CancelSave preferences




UNABLE TO SAVE COOKIE PREFERENCES

We will only store essential cookies at this time, because we were unable to
save your cookie preferences.

If you want to change your cookie preferences, try again later using the link in
the AWS console footer, or contact support if the problem persists.

Dismiss


Contact Us
English


Create an AWS Account
 1. AWS
 2. ...
    
    
 3. Documentation
 4. Amazon SageMaker
 5. Amazon Sagemaker API Reference

Feedback
Preferences


AMAZON SAGEMAKER


AMAZON SAGEMAKER API REFERENCE

 * Welcome
 * Actions
    * Amazon SageMaker Service
       * AddAssociation
       * AddTags
       * AssociateTrialComponent
       * BatchDescribeModelPackage
       * CreateAction
       * CreateAlgorithm
       * CreateApp
       * CreateAppImageConfig
       * CreateArtifact
       * CreateAutoMLJob
       * CreateAutoMLJobV2
       * CreateCluster
       * CreateCodeRepository
       * CreateCompilationJob
       * CreateContext
       * CreateDataQualityJobDefinition
       * CreateDeviceFleet
       * CreateDomain
       * CreateEdgeDeploymentPlan
       * CreateEdgeDeploymentStage
       * CreateEdgePackagingJob
       * CreateEndpoint
       * CreateEndpointConfig
       * CreateExperiment
       * CreateFeatureGroup
       * CreateFlowDefinition
       * CreateHub
       * CreateHumanTaskUi
       * CreateHyperParameterTuningJob
       * CreateImage
       * CreateImageVersion
       * CreateInferenceComponent
       * CreateInferenceExperiment
       * CreateInferenceRecommendationsJob
       * CreateLabelingJob
       * CreateModel
       * CreateModelBiasJobDefinition
       * CreateModelCard
       * CreateModelCardExportJob
       * CreateModelExplainabilityJobDefinition
       * CreateModelPackage
       * CreateModelPackageGroup
       * CreateModelQualityJobDefinition
       * CreateMonitoringSchedule
       * CreateNotebookInstance
       * CreateNotebookInstanceLifecycleConfig
       * CreatePipeline
       * CreatePresignedDomainUrl
       * CreatePresignedNotebookInstanceUrl
       * CreateProcessingJob
       * CreateProject
       * CreateSpace
       * CreateStudioLifecycleConfig
       * CreateTrainingJob
       * CreateTransformJob
       * CreateTrial
       * CreateTrialComponent
       * CreateUserProfile
       * CreateWorkforce
       * CreateWorkteam
       * DeleteAction
       * DeleteAlgorithm
       * DeleteApp
       * DeleteAppImageConfig
       * DeleteArtifact
       * DeleteAssociation
       * DeleteCluster
       * DeleteCodeRepository
       * DeleteCompilationJob
       * DeleteContext
       * DeleteDataQualityJobDefinition
       * DeleteDeviceFleet
       * DeleteDomain
       * DeleteEdgeDeploymentPlan
       * DeleteEdgeDeploymentStage
       * DeleteEndpoint
       * DeleteEndpointConfig
       * DeleteExperiment
       * DeleteFeatureGroup
       * DeleteFlowDefinition
       * DeleteHub
       * DeleteHubContent
       * DeleteHumanTaskUi
       * DeleteHyperParameterTuningJob
       * DeleteImage
       * DeleteImageVersion
       * DeleteInferenceComponent
       * DeleteInferenceExperiment
       * DeleteModel
       * DeleteModelBiasJobDefinition
       * DeleteModelCard
       * DeleteModelExplainabilityJobDefinition
       * DeleteModelPackage
       * DeleteModelPackageGroup
       * DeleteModelPackageGroupPolicy
       * DeleteModelQualityJobDefinition
       * DeleteMonitoringSchedule
       * DeleteNotebookInstance
       * DeleteNotebookInstanceLifecycleConfig
       * DeletePipeline
       * DeleteProject
       * DeleteSpace
       * DeleteStudioLifecycleConfig
       * DeleteTags
       * DeleteTrial
       * DeleteTrialComponent
       * DeleteUserProfile
       * DeleteWorkforce
       * DeleteWorkteam
       * DeregisterDevices
       * DescribeAction
       * DescribeAlgorithm
       * DescribeApp
       * DescribeAppImageConfig
       * DescribeArtifact
       * DescribeAutoMLJob
       * DescribeAutoMLJobV2
       * DescribeCluster
       * DescribeClusterNode
       * DescribeCodeRepository
       * DescribeCompilationJob
       * DescribeContext
       * DescribeDataQualityJobDefinition
       * DescribeDevice
       * DescribeDeviceFleet
       * DescribeDomain
       * DescribeEdgeDeploymentPlan
       * DescribeEdgePackagingJob
       * DescribeEndpoint
       * DescribeEndpointConfig
       * DescribeExperiment
       * DescribeFeatureGroup
       * DescribeFeatureMetadata
       * DescribeFlowDefinition
       * DescribeHub
       * DescribeHubContent
       * DescribeHumanTaskUi
       * DescribeHyperParameterTuningJob
       * DescribeImage
       * DescribeImageVersion
       * DescribeInferenceComponent
       * DescribeInferenceExperiment
       * DescribeInferenceRecommendationsJob
       * DescribeLabelingJob
       * DescribeLineageGroup
       * DescribeModel
       * DescribeModelBiasJobDefinition
       * DescribeModelCard
       * DescribeModelCardExportJob
       * DescribeModelExplainabilityJobDefinition
       * DescribeModelPackage
       * DescribeModelPackageGroup
       * DescribeModelQualityJobDefinition
       * DescribeMonitoringSchedule
       * DescribeNotebookInstance
       * DescribeNotebookInstanceLifecycleConfig
       * DescribePipeline
       * DescribePipelineDefinitionForExecution
       * DescribePipelineExecution
       * DescribeProcessingJob
       * DescribeProject
       * DescribeSpace
       * DescribeStudioLifecycleConfig
       * DescribeSubscribedWorkteam
       * DescribeTrainingJob
       * DescribeTransformJob
       * DescribeTrial
       * DescribeTrialComponent
       * DescribeUserProfile
       * DescribeWorkforce
       * DescribeWorkteam
       * DisableSagemakerServicecatalogPortfolio
       * DisassociateTrialComponent
       * 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
       * ListEndpoints
       * ListExperiments
       * ListFeatureGroups
       * ListFlowDefinitions
       * ListHubContents
       * ListHubContentVersions
       * ListHubs
       * ListHumanTaskUis
       * ListHyperParameterTuningJobs
       * ListImages
       * ListImageVersions
       * ListInferenceComponents
       * ListInferenceExperiments
       * ListInferenceRecommendationsJobs
       * ListInferenceRecommendationsJobSteps
       * ListLabelingJobs
       * ListLabelingJobsForWorkteam
       * ListLineageGroups
       * ListModelBiasJobDefinitions
       * ListModelCardExportJobs
       * ListModelCards
       * ListModelCardVersions
       * ListModelExplainabilityJobDefinitions
       * ListModelMetadata
       * ListModelPackageGroups
       * ListModelPackages
       * ListModelQualityJobDefinitions
       * ListModels
       * ListMonitoringAlertHistory
       * ListMonitoringAlerts
       * ListMonitoringExecutions
       * ListMonitoringSchedules
       * ListNotebookInstanceLifecycleConfigs
       * ListNotebookInstances
       * ListPipelineExecutions
       * ListPipelineExecutionSteps
       * ListPipelineParametersForExecution
       * ListPipelines
       * ListProcessingJobs
       * ListProjects
       * ListResourceCatalogs
       * ListSpaces
       * ListStageDevices
       * ListStudioLifecycleConfigs
       * ListSubscribedWorkteams
       * ListTags
       * ListTrainingJobs
       * ListTrainingJobsForHyperParameterTuningJob
       * ListTransformJobs
       * ListTrialComponents
       * ListTrials
       * ListUserProfiles
       * ListWorkforces
       * ListWorkteams
       * PutModelPackageGroupPolicy
       * QueryLineage
       * RegisterDevices
       * RenderUiTemplate
       * RetryPipelineExecution
       * Search
       * SendPipelineExecutionStepFailure
       * SendPipelineExecutionStepSuccess
       * StartEdgeDeploymentStage
       * StartInferenceExperiment
       * StartMonitoringSchedule
       * StartNotebookInstance
       * StartPipelineExecution
       * StopAutoMLJob
       * StopCompilationJob
       * StopEdgeDeploymentStage
       * StopEdgePackagingJob
       * StopHyperParameterTuningJob
       * StopInferenceExperiment
       * StopInferenceRecommendationsJob
       * StopLabelingJob
       * StopMonitoringSchedule
       * StopNotebookInstance
       * StopPipelineExecution
       * StopProcessingJob
       * StopTrainingJob
       * StopTransformJob
       * UpdateAction
       * UpdateAppImageConfig
       * UpdateArtifact
       * UpdateCluster
       * UpdateCodeRepository
       * UpdateContext
       * UpdateDeviceFleet
       * UpdateDevices
       * UpdateDomain
       * UpdateEndpoint
       * UpdateEndpointWeightsAndCapacities
       * UpdateExperiment
       * UpdateFeatureGroup
       * UpdateFeatureMetadata
       * UpdateHub
       * UpdateImage
       * UpdateImageVersion
       * UpdateInferenceComponent
       * UpdateInferenceComponentRuntimeConfig
       * UpdateInferenceExperiment
       * UpdateModelCard
       * UpdateModelPackage
       * UpdateMonitoringAlert
       * UpdateMonitoringSchedule
       * UpdateNotebookInstance
       * UpdateNotebookInstanceLifecycleConfig
       * UpdatePipeline
       * UpdatePipelineExecution
       * UpdateProject
       * UpdateSpace
       * UpdateTrainingJob
       * UpdateTrial
       * UpdateTrialComponent
       * UpdateUserProfile
       * UpdateWorkforce
       * UpdateWorkteam
   
    * Amazon SageMaker Runtime
       * InvokeEndpoint
       * InvokeEndpointAsync
       * InvokeEndpointWithResponseStream
   
    * Amazon Sagemaker Edge Manager
       * GetDeployments
       * GetDeviceRegistration
       * SendHeartbeat
   
    * Amazon SageMaker Feature Store Runtime
       * BatchGetRecord
       * DeleteRecord
       * GetRecord
       * PutRecord
   
    * Amazon SageMaker geospatial capabilities
       * DeleteEarthObservationJob
       * DeleteVectorEnrichmentJob
       * ExportEarthObservationJob
       * ExportVectorEnrichmentJob
       * GetEarthObservationJob
       * GetRasterDataCollection
       * GetTile
       * GetVectorEnrichmentJob
       * ListEarthObservationJobs
       * ListRasterDataCollections
       * ListTagsForResource
       * ListVectorEnrichmentJobs
       * SearchRasterDataCollection
       * StartEarthObservationJob
       * StartVectorEnrichmentJob
       * StopEarthObservationJob
       * StopVectorEnrichmentJob
       * TagResource
       * UntagResource
   
    * Amazon SageMaker Metrics Service
       * BatchPutMetrics

 * Data Types
    * Amazon SageMaker Service
       * ActionSource
       * ActionSummary
       * AdditionalInferenceSpecificationDefinition
       * AdditionalS3DataSource
       * AgentVersion
       * Alarm
       * AlgorithmSpecification
       * AlgorithmStatusDetails
       * AlgorithmStatusItem
       * AlgorithmSummary
       * AlgorithmValidationProfile
       * AlgorithmValidationSpecification
       * AnnotationConsolidationConfig
       * AppDetails
       * AppImageConfigDetails
       * AppSpecification
       * ArtifactSource
       * ArtifactSourceType
       * ArtifactSummary
       * AssociationSummary
       * AsyncInferenceClientConfig
       * AsyncInferenceConfig
       * AsyncInferenceNotificationConfig
       * AsyncInferenceOutputConfig
       * AthenaDatasetDefinition
       * AutoMLAlgorithmConfig
       * AutoMLCandidate
       * AutoMLCandidateGenerationConfig
       * AutoMLCandidateStep
       * AutoMLChannel
       * AutoMLContainerDefinition
       * AutoMLDataSource
       * AutoMLDataSplitConfig
       * AutoMLJobArtifacts
       * AutoMLJobChannel
       * AutoMLJobCompletionCriteria
       * AutoMLJobConfig
       * AutoMLJobObjective
       * AutoMLJobStepMetadata
       * AutoMLJobSummary
       * AutoMLOutputDataConfig
       * AutoMLPartialFailureReason
       * AutoMLProblemTypeConfig
       * AutoMLProblemTypeResolvedAttributes
       * AutoMLResolvedAttributes
       * AutoMLS3DataSource
       * AutoMLSecurityConfig
       * AutoParameter
       * AutoRollbackConfig
       * Autotune
       * BatchDataCaptureConfig
       * BatchDescribeModelPackageError
       * BatchDescribeModelPackageSummary
       * BatchTransformInput
       * BestObjectiveNotImproving
       * Bias
       * BlueGreenUpdatePolicy
       * CacheHitResult
       * CallbackStepMetadata
       * CandidateArtifactLocations
       * CandidateGenerationConfig
       * CandidateProperties
       * CanvasAppSettings
       * CapacitySize
       * CaptureContentTypeHeader
       * CaptureOption
       * CategoricalParameter
       * CategoricalParameterRange
       * CategoricalParameterRangeSpecification
       * Channel
       * ChannelSpecification
       * CheckpointConfig
       * ClarifyCheckStepMetadata
       * ClarifyExplainerConfig
       * ClarifyInferenceConfig
       * ClarifyShapBaselineConfig
       * ClarifyShapConfig
       * ClarifyTextConfig
       * ClusterInstanceGroupDetails
       * ClusterInstanceGroupSpecification
       * ClusterInstanceStatusDetails
       * ClusterLifeCycleConfig
       * ClusterNodeDetails
       * ClusterNodeSummary
       * ClusterSummary
       * CodeEditorAppSettings
       * CodeRepository
       * CodeRepositorySummary
       * CognitoConfig
       * CognitoMemberDefinition
       * CollectionConfig
       * CollectionConfiguration
       * CompilationJobSummary
       * ConditionStepMetadata
       * ContainerConfig
       * ContainerDefinition
       * ContextSource
       * ContextSummary
       * ContinuousParameterRange
       * ContinuousParameterRangeSpecification
       * ConvergenceDetected
       * CustomFileSystem
       * CustomFileSystemConfig
       * CustomImage
       * CustomizedMetricSpecification
       * CustomPosixUserConfig
       * DataCaptureConfig
       * DataCaptureConfigSummary
       * DataCatalogConfig
       * DataProcessing
       * DataQualityAppSpecification
       * DataQualityBaselineConfig
       * DataQualityJobInput
       * DatasetDefinition
       * DataSource
       * DebugHookConfig
       * DebugRuleConfiguration
       * DebugRuleEvaluationStatus
       * DefaultEbsStorageSettings
       * DefaultSpaceSettings
       * DefaultSpaceStorageSettings
       * DeployedImage
       * DeploymentConfig
       * DeploymentRecommendation
       * DeploymentStage
       * DeploymentStageStatusSummary
       * DerivedInformation
       * DesiredWeightAndCapacity
       * Device
       * DeviceDeploymentSummary
       * DeviceFleetSummary
       * DeviceSelectionConfig
       * DeviceStats
       * DeviceSummary
       * DirectDeploySettings
       * DockerSettings
       * DomainDetails
       * DomainSettings
       * DomainSettingsForUpdate
       * DriftCheckBaselines
       * DriftCheckBias
       * DriftCheckExplainability
       * DriftCheckModelDataQuality
       * DriftCheckModelQuality
       * DynamicScalingConfiguration
       * EbsStorageSettings
       * Edge
       * EdgeDeploymentConfig
       * EdgeDeploymentModelConfig
       * EdgeDeploymentPlanSummary
       * EdgeDeploymentStatus
       * EdgeModel
       * EdgeModelStat
       * EdgeModelSummary
       * EdgeOutputConfig
       * EdgePackagingJobSummary
       * EdgePresetDeploymentOutput
       * EFSFileSystem
       * EFSFileSystemConfig
       * EMRStepMetadata
       * Endpoint
       * EndpointConfigSummary
       * EndpointInfo
       * EndpointInput
       * EndpointInputConfiguration
       * EndpointMetadata
       * EndpointOutputConfiguration
       * EndpointPerformance
       * EndpointSummary
       * EnvironmentParameter
       * EnvironmentParameterRanges
       * Experiment
       * ExperimentConfig
       * ExperimentSource
       * ExperimentSummary
       * Explainability
       * ExplainerConfig
       * FailStepMetadata
       * FeatureDefinition
       * FeatureGroup
       * FeatureGroupSummary
       * FeatureMetadata
       * FeatureParameter
       * FileSource
       * FileSystemConfig
       * FileSystemDataSource
       * Filter
       * FinalAutoMLJobObjectiveMetric
       * FinalHyperParameterTuningJobObjectiveMetric
       * FlowDefinitionOutputConfig
       * FlowDefinitionSummary
       * GenerativeAiSettings
       * GitConfig
       * GitConfigForUpdate
       * HolidayConfigAttributes
       * HubContentDependency
       * HubContentInfo
       * HubInfo
       * HubS3StorageConfig
       * HumanLoopActivationConditionsConfig
       * HumanLoopActivationConfig
       * HumanLoopConfig
       * HumanLoopRequestSource
       * HumanTaskConfig
       * HumanTaskUiSummary
       * HyperbandStrategyConfig
       * HyperParameterAlgorithmSpecification
       * HyperParameterSpecification
       * HyperParameterTrainingJobDefinition
       * HyperParameterTrainingJobSummary
       * HyperParameterTuningInstanceConfig
       * HyperParameterTuningJobCompletionDetails
       * HyperParameterTuningJobConfig
       * HyperParameterTuningJobConsumedResources
       * HyperParameterTuningJobObjective
       * HyperParameterTuningJobSearchEntity
       * HyperParameterTuningJobStrategyConfig
       * HyperParameterTuningJobSummary
       * HyperParameterTuningJobWarmStartConfig
       * HyperParameterTuningResourceConfig
       * IamIdentity
       * IdentityProviderOAuthSetting
       * Image
       * ImageClassificationJobConfig
       * ImageConfig
       * ImageVersion
       * InferenceComponentComputeResourceRequirements
       * InferenceComponentContainerSpecification
       * InferenceComponentContainerSpecificationSummary
       * InferenceComponentRuntimeConfig
       * InferenceComponentRuntimeConfigSummary
       * InferenceComponentSpecification
       * InferenceComponentSpecificationSummary
       * InferenceComponentStartupParameters
       * InferenceComponentSummary
       * InferenceExecutionConfig
       * InferenceExperimentDataStorageConfig
       * InferenceExperimentSchedule
       * InferenceExperimentSummary
       * InferenceMetrics
       * InferenceRecommendation
       * InferenceRecommendationsJob
       * InferenceRecommendationsJobStep
       * InferenceSpecification
       * InfraCheckConfig
       * InputConfig
       * InstanceGroup
       * InstanceMetadataServiceConfiguration
       * IntegerParameterRange
       * IntegerParameterRangeSpecification
       * JupyterLabAppImageConfig
       * JupyterLabAppSettings
       * JupyterServerAppSettings
       * KendraSettings
       * KernelGatewayAppSettings
       * KernelGatewayImageConfig
       * KernelSpec
       * LabelCounters
       * LabelCountersForWorkteam
       * LabelingJobAlgorithmsConfig
       * LabelingJobDataAttributes
       * LabelingJobDataSource
       * LabelingJobForWorkteamSummary
       * LabelingJobInputConfig
       * LabelingJobOutput
       * LabelingJobOutputConfig
       * LabelingJobResourceConfig
       * LabelingJobS3DataSource
       * LabelingJobSnsDataSource
       * LabelingJobStoppingConditions
       * LabelingJobSummary
       * LambdaStepMetadata
       * LastUpdateStatus
       * LineageGroupSummary
       * MemberDefinition
       * MetadataProperties
       * MetricData
       * MetricDatum
       * MetricDefinition
       * MetricSpecification
       * MetricsSource
       * Model
       * ModelAccessConfig
       * ModelArtifacts
       * ModelBiasAppSpecification
       * ModelBiasBaselineConfig
       * ModelBiasJobInput
       * ModelCard
       * ModelCardExportArtifacts
       * ModelCardExportJobSummary
       * ModelCardExportOutputConfig
       * ModelCardSecurityConfig
       * ModelCardSummary
       * ModelCardVersionSummary
       * ModelClientConfig
       * ModelConfiguration
       * ModelDashboardEndpoint
       * ModelDashboardIndicatorAction
       * ModelDashboardModel
       * ModelDashboardModelCard
       * ModelDashboardMonitoringSchedule
       * ModelDataQuality
       * ModelDataSource
       * ModelDeployConfig
       * ModelDeployResult
       * ModelDigests
       * ModelExplainabilityAppSpecification
       * ModelExplainabilityBaselineConfig
       * ModelExplainabilityJobInput
       * ModelInfrastructureConfig
       * ModelInput
       * ModelLatencyThreshold
       * ModelMetadataFilter
       * ModelMetadataSearchExpression
       * ModelMetadataSummary
       * ModelMetrics
       * ModelPackage
       * ModelPackageContainerDefinition
       * ModelPackageGroup
       * ModelPackageGroupSummary
       * ModelPackageStatusDetails
       * ModelPackageStatusItem
       * ModelPackageSummary
       * ModelPackageValidationProfile
       * ModelPackageValidationSpecification
       * ModelQuality
       * ModelQualityAppSpecification
       * ModelQualityBaselineConfig
       * ModelQualityJobInput
       * ModelRegisterSettings
       * ModelStepMetadata
       * ModelSummary
       * ModelVariantConfig
       * ModelVariantConfigSummary
       * MonitoringAlertActions
       * MonitoringAlertHistorySummary
       * MonitoringAlertSummary
       * MonitoringAppSpecification
       * MonitoringBaselineConfig
       * MonitoringClusterConfig
       * MonitoringConstraintsResource
       * MonitoringCsvDatasetFormat
       * MonitoringDatasetFormat
       * MonitoringExecutionSummary
       * MonitoringGroundTruthS3Input
       * MonitoringInput
       * MonitoringJobDefinition
       * MonitoringJobDefinitionSummary
       * MonitoringJsonDatasetFormat
       * MonitoringNetworkConfig
       * MonitoringOutput
       * MonitoringOutputConfig
       * MonitoringParquetDatasetFormat
       * MonitoringResources
       * MonitoringS3Output
       * MonitoringSchedule
       * MonitoringScheduleConfig
       * MonitoringScheduleSummary
       * MonitoringStatisticsResource
       * MonitoringStoppingCondition
       * MultiModelConfig
       * NeoVpcConfig
       * NestedFilters
       * NetworkConfig
       * NotebookInstanceLifecycleConfigSummary
       * NotebookInstanceLifecycleHook
       * NotebookInstanceSummary
       * NotificationConfiguration
       * ObjectiveStatusCounters
       * OfflineStoreConfig
       * OfflineStoreStatus
       * OidcConfig
       * OidcConfigForResponse
       * OidcMemberDefinition
       * OnlineStoreConfig
       * OnlineStoreConfigUpdate
       * OnlineStoreSecurityConfig
       * OutputConfig
       * OutputDataConfig
       * OutputParameter
       * OwnershipSettings
       * OwnershipSettingsSummary
       * ParallelismConfiguration
       * Parameter
       * ParameterRange
       * ParameterRanges
       * Parent
       * ParentHyperParameterTuningJob
       * PendingDeploymentSummary
       * PendingProductionVariantSummary
       * Phase
       * Pipeline
       * PipelineDefinitionS3Location
       * PipelineExecution
       * PipelineExecutionStep
       * PipelineExecutionStepMetadata
       * PipelineExecutionSummary
       * PipelineExperimentConfig
       * PipelineSummary
       * PredefinedMetricSpecification
       * ProcessingClusterConfig
       * ProcessingFeatureStoreOutput
       * ProcessingInput
       * ProcessingJob
       * ProcessingJobStepMetadata
       * ProcessingJobSummary
       * ProcessingOutput
       * ProcessingOutputConfig
       * ProcessingResources
       * ProcessingS3Input
       * ProcessingS3Output
       * ProcessingStoppingCondition
       * ProductionVariant
       * ProductionVariantCoreDumpConfig
       * ProductionVariantManagedInstanceScaling
       * ProductionVariantRoutingConfig
       * ProductionVariantServerlessConfig
       * ProductionVariantServerlessUpdateConfig
       * ProductionVariantStatus
       * ProductionVariantSummary
       * ProfilerConfig
       * ProfilerConfigForUpdate
       * ProfilerRuleConfiguration
       * ProfilerRuleEvaluationStatus
       * Project
       * ProjectSummary
       * PropertyNameQuery
       * PropertyNameSuggestion
       * ProvisioningParameter
       * PublicWorkforceTaskPrice
       * QualityCheckStepMetadata
       * QueryFilters
       * RealTimeInferenceConfig
       * RealTimeInferenceRecommendation
       * RecommendationJobCompiledOutputConfig
       * RecommendationJobContainerConfig
       * RecommendationJobInferenceBenchmark
       * RecommendationJobInputConfig
       * RecommendationJobOutputConfig
       * RecommendationJobPayloadConfig
       * RecommendationJobResourceLimit
       * RecommendationJobStoppingConditions
       * RecommendationJobVpcConfig
       * RecommendationMetrics
       * RedshiftDatasetDefinition
       * RegisterModelStepMetadata
       * RemoteDebugConfig
       * RemoteDebugConfigForUpdate
       * RenderableTask
       * RenderingError
       * RepositoryAuthConfig
       * ResolvedAttributes
       * ResourceCatalog
       * ResourceConfig
       * ResourceConfigForUpdate
       * ResourceLimits
       * ResourceSpec
       * RetentionPolicy
       * RetryStrategy
       * RollingUpdatePolicy
       * RSessionAppSettings
       * RStudioServerProAppSettings
       * RStudioServerProDomainSettings
       * RStudioServerProDomainSettingsForUpdate
       * S3DataSource
       * S3ModelDataSource
       * S3StorageConfig
       * ScalingPolicy
       * ScalingPolicyMetric
       * ScalingPolicyObjective
       * ScheduleConfig
       * SearchExpression
       * SearchRecord
       * SecondaryStatusTransition
       * SelectedStep
       * SelectiveExecutionConfig
       * SelectiveExecutionResult
       * ServiceCatalogProvisionedProductDetails
       * ServiceCatalogProvisioningDetails
       * ServiceCatalogProvisioningUpdateDetails
       * ShadowModeConfig
       * ShadowModelVariantConfig
       * SharingSettings
       * ShuffleConfig
       * SourceAlgorithm
       * SourceAlgorithmSpecification
       * SourceIpConfig
       * SpaceCodeEditorAppSettings
       * SpaceDetails
       * SpaceJupyterLabAppSettings
       * SpaceSettings
       * SpaceSettingsSummary
       * SpaceSharingSettings
       * SpaceSharingSettingsSummary
       * SpaceStorageSettings
       * Stairs
       * StoppingCondition
       * StudioLifecycleConfigDetails
       * SubscribedWorkteam
       * SuggestionQuery
       * TabularJobConfig
       * TabularResolvedAttributes
       * Tag
       * TargetPlatform
       * TargetTrackingScalingPolicyConfiguration
       * TensorBoardAppSettings
       * TensorBoardOutputConfig
       * TextClassificationJobConfig
       * TextGenerationJobConfig
       * TextGenerationResolvedAttributes
       * ThroughputConfig
       * ThroughputConfigDescription
       * ThroughputConfigUpdate
       * TimeSeriesConfig
       * TimeSeriesForecastingJobConfig
       * TimeSeriesForecastingSettings
       * TimeSeriesTransformations
       * TrafficPattern
       * TrafficRoutingConfig
       * TrainingImageConfig
       * TrainingJob
       * TrainingJobDefinition
       * TrainingJobStatusCounters
       * TrainingJobStepMetadata
       * TrainingJobSummary
       * TrainingRepositoryAuthConfig
       * TrainingSpecification
       * TransformDataSource
       * TransformInput
       * TransformJob
       * TransformJobDefinition
       * TransformJobStepMetadata
       * TransformJobSummary
       * TransformOutput
       * TransformResources
       * TransformS3DataSource
       * Trial
       * TrialComponent
       * TrialComponentArtifact
       * TrialComponentMetricSummary
       * TrialComponentParameterValue
       * TrialComponentSimpleSummary
       * TrialComponentSource
       * TrialComponentSourceDetail
       * TrialComponentStatus
       * TrialComponentSummary
       * TrialSource
       * TrialSummary
       * TtlDuration
       * TuningJobCompletionCriteria
       * TuningJobStepMetaData
       * UiConfig
       * UiTemplate
       * UiTemplateInfo
       * USD
       * UserContext
       * UserProfileDetails
       * UserSettings
       * VariantProperty
       * VectorConfig
       * Vertex
       * VisibilityConditions
       * VpcConfig
       * WarmPoolStatus
       * Workforce
       * WorkforceVpcConfigRequest
       * WorkforceVpcConfigResponse
       * WorkspaceSettings
       * Workteam
   
    * Amazon SageMaker Runtime
       * PayloadPart
       * ResponseStream
   
    * Amazon Sagemaker Edge Manager
       * Checksum
       * Definition
       * DeploymentModel
       * DeploymentResult
       * EdgeDeployment
       * EdgeMetric
       * Model
   
    * Amazon SageMaker Feature Store Runtime
       * BatchGetRecordError
       * BatchGetRecordIdentifier
       * BatchGetRecordResultDetail
       * FeatureValue
       * TtlDuration
   
    * Amazon SageMaker geospatial capabilities
       * AreaOfInterest
       * AreaOfInterestGeometry
       * AssetValue
       * BandMathConfigInput
       * CloudMaskingConfigInput
       * CloudRemovalConfigInput
       * CustomIndicesInput
       * EarthObservationJobErrorDetails
       * EoCloudCoverInput
       * ExportErrorDetails
       * ExportErrorDetailsOutput
       * ExportS3DataInput
       * ExportVectorEnrichmentJobOutputConfig
       * Filter
       * Geometry
       * GeoMosaicConfigInput
       * InputConfigInput
       * InputConfigOutput
       * ItemSource
       * JobConfigInput
       * LandCoverSegmentationConfigInput
       * LandsatCloudCoverLandInput
       * ListEarthObservationJobOutputConfig
       * ListVectorEnrichmentJobOutputConfig
       * MapMatchingConfig
       * MultiPolygonGeometryInput
       * Operation
       * OutputBand
       * OutputConfigInput
       * OutputResolutionResamplingInput
       * OutputResolutionStackInput
       * PlatformInput
       * PolygonGeometryInput
       * Properties
       * Property
       * PropertyFilter
       * PropertyFilters
       * RasterDataCollectionMetadata
       * RasterDataCollectionQueryInput
       * RasterDataCollectionQueryOutput
       * RasterDataCollectionQueryWithBandFilterInput
       * ResamplingConfigInput
       * ReverseGeocodingConfig
       * StackConfigInput
       * TemporalStatisticsConfigInput
       * TimeRangeFilterInput
       * TimeRangeFilterOutput
       * UserDefined
       * VectorEnrichmentJobConfig
       * VectorEnrichmentJobDataSourceConfigInput
       * VectorEnrichmentJobErrorDetails
       * VectorEnrichmentJobExportErrorDetails
       * VectorEnrichmentJobInputConfig
       * VectorEnrichmentJobS3Data
       * ViewOffNadirInput
       * ViewSunAzimuthInput
       * ViewSunElevationInput
       * ZonalStatisticsConfigInput
   
    * Amazon SageMaker Metrics Service
       * BatchPutMetricsError
       * RawMetricData

 * Common Parameters
 * Common Errors

CreateEndpoint - Amazon SageMaker
AWSDocumentationAmazon SageMakerAmazon Sagemaker API Reference
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also


CREATEENDPOINT

PDF

Creates an endpoint using the endpoint configuration specified in the request.
SageMaker uses the endpoint to provision resources and deploy models. You create
the endpoint configuration with the CreateEndpointConfig API.

Use this API to deploy models using SageMaker hosting services.

NOTE

You must not delete an EndpointConfig that is in use by an endpoint that is live
or while the UpdateEndpoint or CreateEndpoint operations are being performed on
the endpoint. To update an endpoint, you must create a new EndpointConfig.

The endpoint name must be unique within an AWS Region in your AWS account.

When it receives the request, SageMaker creates the endpoint, launches the
resources (ML compute instances), and deploys the model(s) on them.

NOTE

When you call CreateEndpoint, a load call is made to DynamoDB to verify that
your endpoint configuration exists. When you read data from a DynamoDB table
supporting Eventually Consistent Reads, the response might not reflect the
results of a recently completed write operation. The response might include some
stale data. If the dependent entities are not yet in DynamoDB, this causes a
validation error. If you repeat your read request after a short time, the
response should return the latest data. So retry logic is recommended to handle
these possible issues. We also recommend that customers call
DescribeEndpointConfig before calling CreateEndpoint to minimize the potential
impact of a DynamoDB eventually consistent read.

When SageMaker receives the request, it sets the endpoint status to Creating.
After it creates the endpoint, it sets the status to InService. SageMaker can
then process incoming requests for inferences. To check the status of an
endpoint, use the DescribeEndpoint API.

If any of the models hosted at this endpoint get model data from an Amazon S3
location, SageMaker uses AWS Security Token Service to download model artifacts
from the S3 path you provided. AWS STS is activated in your AWS account by
default. If you previously deactivated AWS STS for a region, you need to
reactivate AWS STS for that region. For more information, see Activating and
Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management
User Guide.

NOTE

To add the IAM role policies for using this API operation, go to the IAM
console, and choose Roles in the left navigation pane. Search the IAM role that
you want to grant access to use the CreateEndpoint and CreateEndpointConfig API
operations, add the following policies to the role.

 * Option 1: For a full SageMaker access, search and attach the
   AmazonSageMakerFullAccess policy.

 * Option 2: For granting a limited access to an IAM role, paste the following
   Action elements manually into the JSON file of the IAM role:
   
   "Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"]
   
   "Resource": [
   
   "arn:aws:sagemaker:region:account-id:endpoint/endpointName"
   
   "arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName"
   
   ]
   
   For more information, see SageMaker API Permissions: Actions, Permissions,
   and Resources Reference.


REQUEST SYNTAX


{
   "DeploymentConfig": { 
      "AutoRollbackConfiguration": { 
         "Alarms": [ 
            { 
               "AlarmName": "string"
            }
         ]
      },
      "BlueGreenUpdatePolicy": { 
         "MaximumExecutionTimeoutInSeconds": number,
         "TerminationWaitInSeconds": number,
         "TrafficRoutingConfiguration": { 
            "CanarySize": { 
               "Type": "string",
               "Value": number
            },
            "LinearStepSize": { 
               "Type": "string",
               "Value": number
            },
            "Type": "string",
            "WaitIntervalInSeconds": number
         }
      },
      "RollingUpdatePolicy": { 
         "MaximumBatchSize": { 
            "Type": "string",
            "Value": number
         },
         "MaximumExecutionTimeoutInSeconds": number,
         "RollbackMaximumBatchSize": { 
            "Type": "string",
            "Value": number
         },
         "WaitIntervalInSeconds": number
      }
   },
   "EndpointConfigName": "string",
   "EndpointName": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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.

DeploymentConfig

The deployment configuration for an endpoint, which contains the desired
deployment strategy and rollback configurations.

Type: DeploymentConfig object

Required: No

EndpointConfigName

The name of an endpoint configuration. For more information, see
CreateEndpointConfig.

Type: String

Length Constraints: Maximum length of 63.

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

Required: Yes

EndpointName

The name of the endpoint.The name must be unique within an AWS Region in your
AWS account. The name is case-insensitive in CreateEndpoint, but the case is
preserved and must be matched in InvokeEndpoint.

Type: String

Length Constraints: Maximum length of 63.

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

Required: Yes

Tags

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

Type: Array of Tag objects

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

Required: No


RESPONSE SYNTAX


{
   "EndpointArn": "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.

EndpointArn

The Amazon Resource Name (ARN) of the endpoint.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

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


ERRORS


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

ResourceLimitExceeded

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

HTTP Status Code: 400


SEE ALSO


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

 * AWS Command Line Interface

 * AWS SDK for .NET

 * AWS SDK for C++

 * AWS SDK for Go

 * AWS SDK for Java V2

 * AWS SDK for JavaScript V3

 * AWS SDK for PHP V3

 * AWS SDK for Python

 * AWS SDK for Ruby V3

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please
refer to your browser's Help pages for instructions.

Document Conventions
CreateEdgePackagingJob
CreateEndpointConfig
Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of
it.



Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.





DID THIS PAGE HELP YOU?

Yes
No
Provide feedback

NEXT TOPIC:

CreateEndpointConfig

PREVIOUS TOPIC:

CreateEdgePackagingJob

NEED HELP?

 * Try AWS re:Post 
 * Connect with an AWS IQ expert 

PrivacySite termsCookie preferences
© 2024, Amazon Web Services, Inc. or its affiliates. All rights reserved.


ON THIS PAGE

 * Request Syntax
 * Request Parameters
 * Response Syntax
 * Response Elements
 * Errors
 * See Also








DID THIS PAGE HELP YOU? - NO



Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.




Feedback