docs.aws.amazon.com Open in urlscan Pro
18.66.147.76  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

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


STOPPROCESSINGJOB

PDF

Stops a processing job.


REQUEST SYNTAX


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

ProcessingJobName

The name of the processing job to stop.

Type: String

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

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

Required: Yes


RESPONSE ELEMENTS


If the action is successful, the service sends back an HTTP 200 response with an
empty HTTP body.


ERRORS


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

ResourceNotFound

Resource being access is not found.

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
StopPipelineExecution
StopTrainingJob
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:

StopTrainingJob

PREVIOUS TOPIC:

StopPipelineExecution

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 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