Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.4/services/sagemaker.ts?docs=full";

§Classes

SageMaker

§Interfaces

ActionSource

A structure describing the source of an action.

ActionSummary

Lists the properties of an action. An action represents an action or activity. Some examples are a workflow step and a model deployment. Generally, an action involves at least one input artifact or output artifact.

AddAssociationRequest
AddAssociationResponse
AdditionalInferenceSpecificationDefinition

A structure of additional Inference Specification. Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package

AddTagsInput
AddTagsOutput
AgentVersion

Edge Manager agent version.

Alarm

An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.

AlgorithmSpecification

Specifies the training algorithm to use in a "CreateTrainingJob" request.

AlgorithmStatusDetails

Specifies the validation and image scan statuses of the algorithm.

AlgorithmStatusItem

Represents the overall status of an algorithm.

AlgorithmSummary

Provides summary information about an algorithm.

AlgorithmValidationProfile

Defines a training job and a batch transform job that SageMaker runs to validate your algorithm.

AlgorithmValidationSpecification

Specifies configurations for one or more training jobs that SageMaker runs to test the algorithm.

AnnotationConsolidationConfig

Configures how labels are consolidated across human workers and processes output data.

AppDetails

Details about an Amazon SageMaker app.

AppImageConfigDetails

The configuration for running a SageMaker image as a KernelGateway app.

AppSpecification

Configuration to run a processing job in a specified container image.

ArtifactSource

A structure describing the source of an artifact.

ArtifactSourceType

The ID and ID type of an artifact source.

ArtifactSummary

Lists a summary of the properties of an artifact. An artifact represents a URI addressable object or data. Some examples are a dataset and a model.

AssociateTrialComponentRequest
AssociateTrialComponentResponse
AssociationSummary

Lists a summary of the properties of an association. An association is an entity that links other lineage or experiment entities. An example would be an association between a training job and a model.

AsyncInferenceClientConfig

Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.

AsyncInferenceConfig

Specifies configuration for how an endpoint performs asynchronous inference.

AsyncInferenceNotificationConfig

Specifies the configuration for notifications of inference results for asynchronous inference.

AsyncInferenceOutputConfig

Specifies the configuration for asynchronous inference invocation outputs.

AthenaDatasetDefinition

Configuration for Athena Dataset Definition input.

AutoMLAlgorithmConfig

The collection of algorithms run on a dataset for training the model candidates of an Autopilot job.

AutoMLCandidate

Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.

AutoMLCandidateGenerationConfig

Stores the configuration information for how a candidate is generated (optional).

AutoMLCandidateStep

Information about the steps for a candidate and what step it is working on.

AutoMLChannel

A channel is a named input source that training algorithms can consume. The validation dataset size is limited to less than 2 GB. The training dataset size must be less than 100 GB. For more information, see .

AutoMLContainerDefinition

A list of container definitions that describe the different containers that make up an AutoML candidate. For more information, see .

AutoMLDataSource

The data source for the Autopilot job.

AutoMLDataSplitConfig

This structure specifies how to split the data into train and validation datasets. The validation and training datasets must contain the same headers. The validation dataset must be less than 2 GB in size.

AutoMLJobArtifacts

The artifacts that are generated during an AutoML job.

AutoMLJobCompletionCriteria

How long a job is allowed to run, or how many candidates a job is allowed to generate.

AutoMLJobConfig

A collection of settings used for an AutoML job.

AutoMLJobObjective

Specifies a metric to minimize or maximize as the objective of a job.

AutoMLJobStepMetadata

Metadata for an AutoML job step.

AutoMLJobSummary

Provides a summary about an AutoML job.

AutoMLOutputDataConfig

The output data configuration.

AutoMLPartialFailureReason

The reason for a partial failure of an AutoML job.

AutoMLS3DataSource

The Amazon S3 data source.

AutoMLSecurityConfig

Security options.

AutoRollbackConfig

Automatic rollback configuration for handling endpoint deployment failures and recovery.

BatchDataCaptureConfig

Configuration to control how SageMaker captures inference data for batch transform jobs.

BatchDescribeModelPackageError

The error code and error description associated with the resource.

BatchDescribeModelPackageInput
BatchDescribeModelPackageOutput
BatchDescribeModelPackageSummary

Provides summary information about the model package.

BatchTransformInput

Input object for the batch transform job.

BestObjectiveNotImproving

A structure that keeps track of which training jobs launched by your hyperparameter tuning job are not improving model performance as evaluated against an objective function.

Bias

Contains bias metrics for a model.

BlueGreenUpdatePolicy

Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.

CacheHitResult

Details on the cache hit of a pipeline execution step.

CallbackStepMetadata

Metadata about a callback step.

CandidateArtifactLocations

The location of artifacts for an AutoML candidate job.

CandidateProperties

The properties of an AutoML candidate job.

CanvasAppSettings

The SageMaker Canvas app settings.

CapacitySize

Specifies the endpoint capacity to activate for production.

CaptureContentTypeHeader

Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.

CaptureOption

Specifies data Model Monitor will capture.

CategoricalParameter

Environment parameters you want to benchmark your load test against.

CategoricalParameterRange

A list of categorical hyperparameters to tune.

CategoricalParameterRangeSpecification

Defines the possible values for a categorical hyperparameter.

Channel

A channel is a named input source that training algorithms can consume.

ChannelSpecification

Defines a named input source, called a channel, to be used by an algorithm.

CheckpointConfig

Contains information about the output location for managed spot training checkpoint data.

ClarifyCheckStepMetadata

The container for the metadata for the ClarifyCheck step. For more information, see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.

ClarifyExplainerConfig

The configuration parameters for the SageMaker Clarify explainer.

ClarifyInferenceConfig

The inference configuration parameter for the model container.

ClarifyShapBaselineConfig

The configuration for the SHAP baseline (also called the background or reference dataset) of the Kernal SHAP algorithm.

ClarifyShapConfig

The configuration for SHAP analysis using SageMaker Clarify Explainer.

ClarifyTextConfig

A parameter used to configure the SageMaker Clarify explainer to treat text features as text so that explanations are provided for individual units of text. Required only for natural language processing (NLP) explainability.

CodeRepository

A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.

CodeRepositorySummary

Specifies summary information about a Git repository.

CognitoConfig

Use this parameter to configure your Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

CognitoMemberDefinition

Identifies a Amazon Cognito user group. A user group can be used in on or more work teams.

CollectionConfiguration

Configuration information for the Amazon SageMaker Debugger output tensor collections.

CompilationJobSummary

A summary of a model compilation job.

ConditionStepMetadata

Metadata for a Condition step.

ContainerDefinition

Describes the container, as part of model definition.

ContextSource

A structure describing the source of a context.

ContextSummary

Lists a summary of the properties of a context. A context provides a logical grouping of other entities.

ContinuousParameterRange

A list of continuous hyperparameters to tune.

ContinuousParameterRangeSpecification

Defines the possible values for a continuous hyperparameter.

ConvergenceDetected

A flag to indicating that automatic model tuning (AMT) has detected model convergence, defined as a lack of significant improvement (1% or less) against an objective metric.

CreateActionRequest
CreateActionResponse
CreateAlgorithmInput
CreateAlgorithmOutput
CreateAppImageConfigRequest
CreateAppImageConfigResponse
CreateAppRequest
CreateAppResponse
CreateArtifactRequest
CreateArtifactResponse
CreateAutoMLJobRequest
CreateAutoMLJobResponse
CreateCodeRepositoryInput
CreateCodeRepositoryOutput
CreateCompilationJobRequest
CreateCompilationJobResponse
CreateContextRequest
CreateContextResponse
CreateDataQualityJobDefinitionRequest
CreateDataQualityJobDefinitionResponse
CreateDeviceFleetRequest
CreateDomainRequest
CreateDomainResponse
CreateEdgeDeploymentPlanRequest
CreateEdgeDeploymentPlanResponse
CreateEdgeDeploymentStageRequest
CreateEdgePackagingJobRequest
CreateEndpointConfigInput
CreateEndpointConfigOutput
CreateEndpointInput
CreateEndpointOutput
CreateExperimentRequest
CreateExperimentResponse
CreateFeatureGroupRequest
CreateFeatureGroupResponse
CreateFlowDefinitionRequest
CreateFlowDefinitionResponse
CreateHubRequest
CreateHubResponse
CreateHumanTaskUiRequest
CreateHumanTaskUiResponse
CreateHyperParameterTuningJobRequest
CreateHyperParameterTuningJobResponse
CreateImageRequest
CreateImageResponse
CreateImageVersionRequest
CreateImageVersionResponse
CreateInferenceExperimentRequest
CreateInferenceExperimentResponse
CreateInferenceRecommendationsJobRequest
CreateInferenceRecommendationsJobResponse
CreateLabelingJobRequest
CreateLabelingJobResponse
CreateModelBiasJobDefinitionRequest
CreateModelBiasJobDefinitionResponse
CreateModelCardExportJobRequest
CreateModelCardExportJobResponse
CreateModelCardRequest
CreateModelCardResponse
CreateModelExplainabilityJobDefinitionRequest
CreateModelExplainabilityJobDefinitionResponse
CreateModelInput
CreateModelOutput
CreateModelPackageGroupInput
CreateModelPackageGroupOutput
CreateModelPackageInput
CreateModelPackageOutput
CreateModelQualityJobDefinitionRequest
CreateModelQualityJobDefinitionResponse
CreateMonitoringScheduleRequest
CreateMonitoringScheduleResponse
CreateNotebookInstanceInput
CreateNotebookInstanceLifecycleConfigInput
CreateNotebookInstanceLifecycleConfigOutput
CreateNotebookInstanceOutput
CreatePipelineRequest
CreatePipelineResponse
CreatePresignedDomainUrlRequest
CreatePresignedDomainUrlResponse
CreatePresignedNotebookInstanceUrlInput
CreatePresignedNotebookInstanceUrlOutput
CreateProcessingJobRequest
CreateProcessingJobResponse
CreateProjectInput
CreateProjectOutput
CreateSpaceRequest
CreateSpaceResponse
CreateStudioLifecycleConfigRequest
CreateStudioLifecycleConfigResponse
CreateTrainingJobRequest
CreateTrainingJobResponse
CreateTransformJobRequest
CreateTransformJobResponse
CreateTrialComponentRequest
CreateTrialComponentResponse
CreateTrialRequest
CreateTrialResponse
CreateUserProfileRequest
CreateUserProfileResponse
CreateWorkforceRequest
CreateWorkforceResponse
CreateWorkteamRequest
CreateWorkteamResponse
CustomImage

A custom SageMaker image. For more information, see Bring your own SageMaker image.

DataCaptureConfig

Configuration to control how SageMaker captures inference data.

DataCaptureConfigSummary

The currently active data capture configuration used by your Endpoint.

DataCatalogConfig

The meta data of the Glue table which serves as data catalog for the OfflineStore.

DataProcessing

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

DataQualityAppSpecification

Information about the container that a data quality monitoring job runs.

DataQualityBaselineConfig

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

DataQualityJobInput

The input for the data quality monitoring job. Currently endpoints are supported for input.

DatasetDefinition

Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition types.

DataSource

Describes the location of the channel data.

DebugHookConfig

Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the DebugHookConfig parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

DebugRuleConfiguration

Configuration information for SageMaker Debugger rules for debugging. To learn more about how to configure the DebugRuleConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

DebugRuleEvaluationStatus

Information about the status of the rule evaluation.

DefaultSpaceSettings

A collection of settings that apply to spaces created in the Domain.

DeleteActionRequest
DeleteActionResponse
DeleteAlgorithmInput
DeleteAppImageConfigRequest
DeleteAppRequest
DeleteArtifactRequest
DeleteArtifactResponse
DeleteAssociationRequest
DeleteAssociationResponse
DeleteCodeRepositoryInput
DeleteContextRequest
DeleteContextResponse
DeleteDataQualityJobDefinitionRequest
DeleteDeviceFleetRequest
DeleteDomainRequest
DeleteEdgeDeploymentPlanRequest
DeleteEdgeDeploymentStageRequest
DeleteEndpointConfigInput
DeleteEndpointInput
DeleteExperimentRequest
DeleteExperimentResponse
DeleteFeatureGroupRequest
DeleteFlowDefinitionRequest
DeleteHubContentRequest
DeleteHubRequest
DeleteHumanTaskUiRequest
DeleteImageRequest
DeleteImageVersionRequest
DeleteInferenceExperimentRequest
DeleteInferenceExperimentResponse
DeleteModelBiasJobDefinitionRequest
DeleteModelCardRequest
DeleteModelExplainabilityJobDefinitionRequest
DeleteModelInput
DeleteModelPackageGroupInput
DeleteModelPackageGroupPolicyInput
DeleteModelPackageInput
DeleteModelQualityJobDefinitionRequest
DeleteMonitoringScheduleRequest
DeleteNotebookInstanceInput
DeleteNotebookInstanceLifecycleConfigInput
DeletePipelineRequest
DeletePipelineResponse
DeleteProjectInput
DeleteSpaceRequest
DeleteStudioLifecycleConfigRequest
DeleteTagsInput
DeleteTrialComponentRequest
DeleteTrialComponentResponse
DeleteTrialRequest
DeleteTrialResponse
DeleteUserProfileRequest
DeleteWorkforceRequest
DeleteWorkteamRequest
DeleteWorkteamResponse
DeployedImage

Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this "ProductionVariant".

DeploymentConfig

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

DeploymentStage

Contains information about a stage in an edge deployment plan.

DeploymentStageStatusSummary

Contains information summarizing the deployment stage results.

DeregisterDevicesRequest
DescribeActionRequest
DescribeActionResponse
DescribeAlgorithmInput
DescribeAlgorithmOutput
DescribeAppImageConfigRequest
DescribeAppImageConfigResponse
DescribeAppRequest
DescribeAppResponse
DescribeArtifactRequest
DescribeArtifactResponse
DescribeAutoMLJobRequest
DescribeAutoMLJobResponse
DescribeCodeRepositoryInput
DescribeCodeRepositoryOutput
DescribeCompilationJobRequest
DescribeCompilationJobResponse
DescribeContextRequest
DescribeContextResponse
DescribeDataQualityJobDefinitionRequest
DescribeDataQualityJobDefinitionResponse
DescribeDeviceFleetRequest
DescribeDeviceFleetResponse
DescribeDeviceRequest
DescribeDeviceResponse
DescribeDomainRequest
DescribeDomainResponse
DescribeEdgeDeploymentPlanRequest
DescribeEdgeDeploymentPlanResponse
DescribeEdgePackagingJobRequest
DescribeEdgePackagingJobResponse
DescribeEndpointConfigInput
DescribeEndpointConfigOutput
DescribeEndpointInput
DescribeEndpointOutput
DescribeExperimentRequest
DescribeExperimentResponse
DescribeFeatureGroupRequest
DescribeFeatureGroupResponse
DescribeFeatureMetadataRequest
DescribeFeatureMetadataResponse
DescribeFlowDefinitionRequest
DescribeFlowDefinitionResponse
DescribeHubContentRequest
DescribeHubContentResponse
DescribeHubRequest
DescribeHubResponse
DescribeHumanTaskUiRequest
DescribeHumanTaskUiResponse
DescribeHyperParameterTuningJobRequest
DescribeHyperParameterTuningJobResponse
DescribeImageRequest
DescribeImageResponse
DescribeImageVersionRequest
DescribeImageVersionResponse
DescribeInferenceExperimentRequest
DescribeInferenceExperimentResponse
DescribeInferenceRecommendationsJobRequest
DescribeInferenceRecommendationsJobResponse
DescribeLabelingJobRequest
DescribeLabelingJobResponse
DescribeLineageGroupRequest
DescribeLineageGroupResponse
DescribeModelBiasJobDefinitionRequest
DescribeModelBiasJobDefinitionResponse
DescribeModelCardExportJobRequest
DescribeModelCardExportJobResponse
DescribeModelCardRequest
DescribeModelCardResponse
DescribeModelExplainabilityJobDefinitionRequest
DescribeModelExplainabilityJobDefinitionResponse
DescribeModelInput
DescribeModelOutput
DescribeModelPackageGroupInput
DescribeModelPackageGroupOutput
DescribeModelPackageInput
DescribeModelPackageOutput
DescribeModelQualityJobDefinitionRequest
DescribeModelQualityJobDefinitionResponse
DescribeMonitoringScheduleRequest
DescribeMonitoringScheduleResponse
DescribeNotebookInstanceInput
DescribeNotebookInstanceLifecycleConfigInput
DescribeNotebookInstanceLifecycleConfigOutput
DescribeNotebookInstanceOutput
DescribePipelineDefinitionForExecutionRequest
DescribePipelineDefinitionForExecutionResponse
DescribePipelineExecutionRequest
DescribePipelineExecutionResponse
DescribePipelineRequest
DescribePipelineResponse
DescribeProcessingJobRequest
DescribeProcessingJobResponse
DescribeProjectInput
DescribeProjectOutput
DescribeSpaceRequest
DescribeSpaceResponse
DescribeStudioLifecycleConfigRequest
DescribeStudioLifecycleConfigResponse
DescribeSubscribedWorkteamRequest
DescribeSubscribedWorkteamResponse
DescribeTrainingJobRequest
DescribeTrainingJobResponse
DescribeTransformJobRequest
DescribeTransformJobResponse
DescribeTrialComponentRequest
DescribeTrialComponentResponse
DescribeTrialRequest
DescribeTrialResponse
DescribeUserProfileRequest
DescribeUserProfileResponse
DescribeWorkforceRequest
DescribeWorkforceResponse
DescribeWorkteamRequest
DescribeWorkteamResponse
DesiredWeightAndCapacity

Specifies weight and capacity values for a production variant.

Device

Information of a particular device.

DeviceDeploymentSummary

Contains information summarizing device details and deployment status.

DeviceFleetSummary

Summary of the device fleet.

DeviceSelectionConfig

Contains information about the configurations of selected devices.

DeviceStats

Status of devices.

DeviceSummary

Summary of the device.

DisassociateTrialComponentRequest
DisassociateTrialComponentResponse
DomainDetails

The domain's details.

DomainSettings

A collection of settings that apply to the SageMaker Domain. These settings are specified through the CreateDomain API call.

DomainSettingsForUpdate

A collection of Domain configuration settings to update.

DriftCheckBaselines

Represents the drift check baselines that can be used when the model monitor is set using the model package.

DriftCheckBias

Represents the drift check bias baselines that can be used when the model monitor is set using the model package.

DriftCheckExplainability

Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.

DriftCheckModelDataQuality

Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.

DriftCheckModelQuality

Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.

Edge

A directed edge connecting two lineage entities.

EdgeDeploymentConfig

Contains information about the configuration of a deployment.

EdgeDeploymentModelConfig

Contains information about the configuration of a model in a deployment.

EdgeDeploymentPlanSummary

Contains information summarizing an edge deployment plan.

EdgeDeploymentStatus

Contains information summarizing the deployment stage results.

EdgeModel

The model on the edge device.

EdgeModelStat

Status of edge devices with this model.

EdgeModelSummary

Summary of model on edge device.

EdgeOutputConfig

The output configuration.

EdgePackagingJobSummary

Summary of edge packaging job.

EdgePresetDeploymentOutput

The output of a SageMaker Edge Manager deployable resource.

EMRStepMetadata

The configurations and outcomes of an Amazon EMR step execution.

Endpoint

A hosted endpoint for real-time inference.

EndpointConfigSummary

Provides summary information for an endpoint configuration.

EndpointInfo

Details about a customer endpoint that was compared in an Inference Recommender job.

EndpointInput

Input object for the endpoint

EndpointInputConfiguration

The endpoint configuration for the load test.

EndpointMetadata

The metadata of the endpoint.

EndpointOutputConfiguration

The endpoint configuration made by Inference Recommender during a recommendation job.

EndpointPerformance

The performance results from running an Inference Recommender job on an existing endpoint.

EndpointSummary

Provides summary information for an endpoint.

EnvironmentParameter

A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.

EnvironmentParameterRanges

Specifies the range of environment parameters

Experiment

The properties of an experiment as returned by the "Search" API.

ExperimentConfig

Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:

ExperimentSource

The source of the experiment.

ExperimentSummary

A summary of the properties of an experiment. To get the complete set of properties, call the "DescribeExperiment" API and provide the ExperimentName.

Explainability

Contains explainability metrics for a model.

ExplainerConfig

A parameter to activate explainers.

FailStepMetadata

The container for the metadata for Fail step.

FeatureDefinition

A list of features. You must include FeatureName and FeatureType. Valid feature FeatureTypes are Integral, Fractional and String.

FeatureGroup

Amazon SageMaker Feature Store stores features in a collection called Feature Group. A Feature Group can be visualized as a table which has rows, with a unique identifier for each row where each column in the table is a feature. In principle, a Feature Group is composed of features and values per features.

FeatureGroupSummary

The name, Arn, CreationTime, FeatureGroup values, LastUpdatedTime and EnableOnlineStorage status of a FeatureGroup.

FeatureMetadata

The metadata for a feature. It can either be metadata that you specify, or metadata that is updated automatically.

FeatureParameter

A key-value pair that you specify to describe the feature.

FileSource

Contains details regarding the file source.

FileSystemConfig

The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.

FileSystemDataSource

Specifies a file system data source for a channel.

Filter

A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the "Search" API.

FinalAutoMLJobObjectiveMetric

The best candidate result from an AutoML training job.

FinalHyperParameterTuningJobObjectiveMetric

Shows the final value for the objective metric for a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of "HyperParameterTuningJobConfig".

FlowDefinitionOutputConfig

Contains information about where human output will be stored.

FlowDefinitionSummary

Contains summary information about the flow definition.

GetDeviceFleetReportRequest
GetDeviceFleetReportResponse
GetLineageGroupPolicyRequest
GetLineageGroupPolicyResponse
GetModelPackageGroupPolicyInput
GetModelPackageGroupPolicyOutput
GetSagemakerServicecatalogPortfolioStatusOutput
GetSearchSuggestionsRequest
GetSearchSuggestionsResponse
GitConfig

Specifies configuration details for a Git repository in your Amazon Web Services account.

GitConfigForUpdate

Specifies configuration details for a Git repository when the repository is updated.

HubContentDependency

Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.

HubContentInfo

Information about hub content.

HubInfo

Information about a hub.

HubS3StorageConfig

The Amazon S3 storage configuration of a hub.

HumanLoopActivationConditionsConfig

Defines under what conditions SageMaker creates a human loop. Used within . See for the required format of activation conditions.

HumanLoopActivationConfig

Provides information about how and under what conditions SageMaker creates a human loop. If HumanLoopActivationConfig is not given, then all requests go to humans.

HumanLoopConfig

Describes the work to be performed by human workers.

HumanLoopRequestSource

Container for configuring the source of human task requests.

HumanTaskConfig

Information required for human workers to complete a labeling task.

HumanTaskUiSummary

Container for human task user interface information.

HyperbandStrategyConfig

The configuration for Hyperband, a multi-fidelity based hyperparameter tuning strategy. Hyperband uses the final and intermediate results of a training job to dynamically allocate resources to utilized hyperparameter configurations while automatically stopping under-performing configurations. This parameter should be provided only if Hyperband is selected as the StrategyConfig under the HyperParameterTuningJobConfig API.

HyperParameterAlgorithmSpecification

Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.

HyperParameterSpecification

Defines a hyperparameter to be used by an algorithm.

HyperParameterTrainingJobDefinition

Defines the training jobs launched by a hyperparameter tuning job.

HyperParameterTrainingJobSummary

The container for the summary information about a training job.

HyperParameterTuningInstanceConfig

The configuration for hyperparameter tuning resources for use in training jobs launched by the tuning job. These resources include compute instances and storage volumes. Specify one or more compute instance configurations and allocation strategies to select resources (optional).

HyperParameterTuningJobCompletionDetails

A structure that contains runtime information about both current and completed hyperparameter tuning jobs.

HyperParameterTuningJobConfig

Configures a hyperparameter tuning job.

HyperParameterTuningJobConsumedResources

The total resources consumed by your hyperparameter tuning job.

HyperParameterTuningJobObjective

Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter.

HyperParameterTuningJobSearchEntity

An entity returned by the SearchRecord API containing the properties of a hyperparameter tuning job.

HyperParameterTuningJobStrategyConfig

The configuration for a training job launched by a hyperparameter tuning job. Choose Bayesian for Bayesian optimization, and Random for random search optimization. For more advanced use cases, use Hyperband, which evaluates objective metrics for training jobs after every epoch. For more information about strategies, see How Hyperparameter Tuning Works.

HyperParameterTuningJobSummary

Provides summary information about a hyperparameter tuning job.

HyperParameterTuningJobWarmStartConfig

Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

HyperParameterTuningResourceConfig

The configuration of resources, including compute instances and storage volumes for use in training jobs launched by hyperparameter tuning jobs. HyperParameterTuningResourceConfig is similar to ResourceConfig, but has the additional InstanceConfigs and AllocationStrategy fields to allow for flexible instance management. Specify one or more instance types, count, and the allocation strategy for instance selection.

Image

A SageMaker image. A SageMaker image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker ImageVersion.

ImageConfig

Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC).

ImageVersion

A version of a SageMaker Image. A version represents an existing container image.

ImportHubContentRequest
ImportHubContentResponse
InferenceExecutionConfig

Specifies details about how containers in a multi-container endpoint are run.

InferenceExperimentDataStorageConfig

The Amazon S3 location and configuration for storing inference request and response data.

InferenceExperimentSchedule

The start and end times of an inference experiment.

InferenceExperimentSummary

Lists a summary of properties of an inference experiment.

InferenceMetrics

The metrics for an existing endpoint compared in an Inference Recommender job.

InferenceRecommendation

A list of recommendations made by Amazon SageMaker Inference Recommender.

InferenceRecommendationsJob

A structure that contains a list of recommendation jobs.

InferenceRecommendationsJobStep

A returned array object for the Steps response field in the ListInferenceRecommendationsJobSteps API command.

InferenceSpecification

Defines how to perform inference generation after a training job is run.

InputConfig

Contains information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

InstanceGroup

Defines an instance group for heterogeneous cluster training. When requesting a training job using the CreateTrainingJob API, you can configure multiple instance groups .

InstanceMetadataServiceConfiguration

Information on the IMDS configuration of the notebook instance

IntegerParameterRange

For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.

IntegerParameterRangeSpecification

Defines the possible values for an integer hyperparameter.

JupyterServerAppSettings

The JupyterServer app settings.

KernelGatewayAppSettings

The KernelGateway app settings.

KernelGatewayImageConfig

The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app.

KernelSpec

The specification of a Jupyter kernel.

LabelCounters

Provides a breakdown of the number of objects labeled.

LabelCountersForWorkteam

Provides counts for human-labeled tasks in the labeling job.

LabelingJobAlgorithmsConfig

Provides configuration information for auto-labeling of your data objects. A LabelingJobAlgorithmsConfig object must be supplied in order to use auto-labeling.

LabelingJobDataAttributes

Attributes of the data specified by the customer. Use these to describe the data to be labeled.

LabelingJobDataSource

Provides information about the location of input data.

LabelingJobForWorkteamSummary

Provides summary information for a work team.

LabelingJobInputConfig

Input configuration information for a labeling job.

LabelingJobOutput

Specifies the location of the output produced by the labeling job.

LabelingJobOutputConfig

Output configuration information for a labeling job.

LabelingJobResourceConfig

Configure encryption on the storage volume attached to the ML compute instance used to run automated data labeling model training and inference.

LabelingJobS3DataSource

The Amazon S3 location of the input data objects.

LabelingJobSnsDataSource

An Amazon SNS data source used for streaming labeling jobs.

LabelingJobStoppingConditions

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

LabelingJobSummary

Provides summary information about a labeling job.

LambdaStepMetadata

Metadata for a Lambda step.

LastUpdateStatus

A value that indicates whether the update was successful.

LineageGroupSummary

Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity resources.

ListActionsRequest
ListActionsResponse
ListAlgorithmsInput
ListAlgorithmsOutput
ListAliasesRequest
ListAliasesResponse
ListAppImageConfigsRequest
ListAppImageConfigsResponse
ListAppsRequest
ListAppsResponse
ListArtifactsRequest
ListArtifactsResponse
ListAssociationsRequest
ListAssociationsResponse
ListAutoMLJobsRequest
ListAutoMLJobsResponse
ListCandidatesForAutoMLJobRequest
ListCandidatesForAutoMLJobResponse
ListCodeRepositoriesInput
ListCodeRepositoriesOutput
ListCompilationJobsRequest
ListCompilationJobsResponse
ListContextsRequest
ListContextsResponse
ListDataQualityJobDefinitionsRequest
ListDataQualityJobDefinitionsResponse
ListDeviceFleetsRequest
ListDeviceFleetsResponse
ListDevicesRequest
ListDevicesResponse
ListDomainsRequest
ListDomainsResponse
ListEdgeDeploymentPlansRequest
ListEdgeDeploymentPlansResponse
ListEdgePackagingJobsRequest
ListEdgePackagingJobsResponse
ListEndpointConfigsInput
ListEndpointConfigsOutput
ListEndpointsInput
ListEndpointsOutput
ListExperimentsRequest
ListExperimentsResponse
ListFeatureGroupsRequest
ListFeatureGroupsResponse
ListFlowDefinitionsRequest
ListFlowDefinitionsResponse
ListHubContentsRequest
ListHubContentsResponse
ListHubContentVersionsRequest
ListHubContentVersionsResponse
ListHubsRequest
ListHubsResponse
ListHumanTaskUisRequest
ListHumanTaskUisResponse
ListHyperParameterTuningJobsRequest
ListHyperParameterTuningJobsResponse
ListImagesRequest
ListImagesResponse
ListImageVersionsRequest
ListImageVersionsResponse
ListInferenceExperimentsRequest
ListInferenceExperimentsResponse
ListInferenceRecommendationsJobsRequest
ListInferenceRecommendationsJobsResponse
ListInferenceRecommendationsJobStepsRequest
ListInferenceRecommendationsJobStepsResponse
ListLabelingJobsForWorkteamRequest
ListLabelingJobsForWorkteamResponse
ListLabelingJobsRequest
ListLabelingJobsResponse
ListLineageGroupsRequest
ListLineageGroupsResponse
ListModelBiasJobDefinitionsRequest
ListModelBiasJobDefinitionsResponse
ListModelCardExportJobsRequest
ListModelCardExportJobsResponse
ListModelCardsRequest
ListModelCardsResponse
ListModelCardVersionsRequest
ListModelCardVersionsResponse
ListModelExplainabilityJobDefinitionsRequest
ListModelExplainabilityJobDefinitionsResponse
ListModelMetadataRequest
ListModelMetadataResponse
ListModelPackageGroupsInput
ListModelPackageGroupsOutput
ListModelPackagesInput
ListModelPackagesOutput
ListModelQualityJobDefinitionsRequest
ListModelQualityJobDefinitionsResponse
ListModelsInput
ListModelsOutput
ListMonitoringAlertHistoryRequest
ListMonitoringAlertHistoryResponse
ListMonitoringAlertsRequest
ListMonitoringAlertsResponse
ListMonitoringExecutionsRequest
ListMonitoringExecutionsResponse
ListMonitoringSchedulesRequest
ListMonitoringSchedulesResponse
ListNotebookInstanceLifecycleConfigsInput
ListNotebookInstanceLifecycleConfigsOutput
ListNotebookInstancesInput
ListNotebookInstancesOutput
ListPipelineExecutionsRequest
ListPipelineExecutionsResponse
ListPipelineExecutionStepsRequest
ListPipelineExecutionStepsResponse
ListPipelineParametersForExecutionRequest
ListPipelineParametersForExecutionResponse
ListPipelinesRequest
ListPipelinesResponse
ListProcessingJobsRequest
ListProcessingJobsResponse
ListProjectsInput
ListProjectsOutput
ListSpacesRequest
ListSpacesResponse
ListStageDevicesRequest
ListStageDevicesResponse
ListStudioLifecycleConfigsRequest
ListStudioLifecycleConfigsResponse
ListSubscribedWorkteamsRequest
ListSubscribedWorkteamsResponse
ListTagsInput
ListTagsOutput
ListTrainingJobsForHyperParameterTuningJobRequest
ListTrainingJobsForHyperParameterTuningJobResponse
ListTrainingJobsRequest
ListTrainingJobsResponse
ListTransformJobsRequest
ListTransformJobsResponse
ListTrialComponentsRequest
ListTrialComponentsResponse
ListTrialsRequest
ListTrialsResponse
ListUserProfilesRequest
ListUserProfilesResponse
ListWorkforcesRequest
ListWorkforcesResponse
ListWorkteamsRequest
ListWorkteamsResponse
MemberDefinition

Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.

MetadataProperties

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

MetricData

The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.

MetricDatum

Information about the metric for a candidate produced by an AutoML job.

MetricDefinition

Specifies a metric that the training algorithm writes to stderr or stdout. SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.

MetricsSource

Details about the metrics source.

Model

The properties of a model as returned by the "Search" API.

ModelArtifacts

Provides information about the location that is configured for storing model artifacts.

ModelBiasAppSpecification

Docker container image configuration object for the model bias job.

ModelBiasBaselineConfig

The configuration for a baseline model bias job.

ModelBiasJobInput

Inputs for the model bias job.

ModelCard

An Amazon SageMaker Model Card.

ModelCardExportArtifacts

The artifacts of the model card export job.

ModelCardExportJobSummary

The summary of the Amazon SageMaker Model Card export job.

ModelCardExportOutputConfig

Configure the export output details for an Amazon SageMaker Model Card.

ModelCardSecurityConfig

Configure the security settings to protect model card data.

ModelCardSummary

A summary of the model card.

ModelCardVersionSummary

A summary of a specific version of the model card.

ModelClientConfig

Configures the timeout and maximum number of retries for processing a transform job invocation.

ModelConfiguration

Defines the model configuration. Includes the specification name and environment parameters.

ModelDashboardEndpoint

An endpoint that hosts a model displayed in the Amazon SageMaker Model Dashboard.

ModelDashboardIndicatorAction

An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into InAlert status.

ModelDashboardModel

A model displayed in the Amazon SageMaker Model Dashboard.

ModelDashboardModelCard

The model card for a model displayed in the Amazon SageMaker Model Dashboard.

ModelDashboardMonitoringSchedule

A monitoring schedule for a model displayed in the Amazon SageMaker Model Dashboard.

ModelDataQuality

Data quality constraints and statistics for a model.

ModelDeployConfig

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

ModelDeployResult

Provides information about the endpoint of the model deployment.

ModelDigests

Provides information to verify the integrity of stored model artifacts.

ModelExplainabilityAppSpecification

Docker container image configuration object for the model explainability job.

ModelExplainabilityBaselineConfig

The configuration for a baseline model explainability job.

ModelExplainabilityJobInput

Inputs for the model explainability job.

ModelInfrastructureConfig

The configuration for the infrastructure that the model will be deployed to.

ModelInput

Input object for the model.

ModelLatencyThreshold

The model latency threshold.

ModelMetadataFilter

Part of the search expression. You can specify the name and value (domain, task, framework, framework version, task, and model).

ModelMetadataSearchExpression

One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results

ModelMetadataSummary

A summary of the model metadata.

ModelMetrics

Contains metrics captured from a model.

ModelPackage

A versioned model that can be deployed for SageMaker inference.

ModelPackageContainerDefinition

Describes the Docker container for the model package.

ModelPackageGroup

A group of versioned models in the model registry.

ModelPackageGroupSummary

Summary information about a model group.

ModelPackageStatusDetails

Specifies the validation and image scan statuses of the model package.

ModelPackageStatusItem

Represents the overall status of a model package.

ModelPackageSummary

Provides summary information about a model package.

ModelPackageValidationProfile

Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.

ModelPackageValidationSpecification

Specifies batch transform jobs that SageMaker runs to validate your model package.

ModelQuality

Model quality statistics and constraints.

ModelQualityAppSpecification

Container image configuration object for the monitoring job.

ModelQualityBaselineConfig

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

ModelQualityJobInput

The input for the model quality monitoring job. Currently endponts are supported for input for model quality monitoring jobs.

ModelStepMetadata

Metadata for Model steps.

ModelSummary

Provides summary information about a model.

ModelVariantConfig

Contains information about the deployment options of a model.

ModelVariantConfigSummary

Summary of the deployment configuration of a model.

MonitoringAlertActions

A list of alert actions taken in response to an alert going into InAlert status.

MonitoringAlertHistorySummary

Provides summary information of an alert's history.

MonitoringAlertSummary

Provides summary information about a monitor alert.

MonitoringAppSpecification

Container image configuration object for the monitoring job.

MonitoringBaselineConfig

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

MonitoringClusterConfig

Configuration for the cluster used to run model monitoring jobs.

MonitoringConstraintsResource

The constraints resource for a monitoring job.

MonitoringCsvDatasetFormat

Represents the CSV dataset format used when running a monitoring job.

MonitoringDatasetFormat

Represents the dataset format used when running a monitoring job.

MonitoringExecutionSummary

Summary of information about the last monitoring job to run.

MonitoringGroundTruthS3Input

The ground truth labels for the dataset used for the monitoring job.

MonitoringInput

The inputs for a monitoring job.

MonitoringJobDefinition

Defines the monitoring job.

MonitoringJobDefinitionSummary

Summary information about a monitoring job.

MonitoringJsonDatasetFormat

Represents the JSON dataset format used when running a monitoring job.

MonitoringNetworkConfig

The networking configuration for the monitoring job.

MonitoringOutput

The output object for a monitoring job.

MonitoringOutputConfig

The output configuration for monitoring jobs.

MonitoringParquetDatasetFormat

Represents the Parquet dataset format used when running a monitoring job.

MonitoringResources

Identifies the resources to deploy for a monitoring job.

MonitoringS3Output

Information about where and how you want to store the results of a monitoring job.

MonitoringSchedule

A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model Monitor.

MonitoringScheduleConfig

Configures the monitoring schedule and defines the monitoring job.

MonitoringScheduleSummary

Summarizes the monitoring schedule.

MonitoringStatisticsResource

The statistics resource for a monitoring job.

MonitoringStoppingCondition

A time limit for how long the monitoring job is allowed to run before stopping.

MultiModelConfig

Specifies additional configuration for hosting multi-model endpoints.

NeoVpcConfig

The "VpcConfig" configuration object that specifies the VPC that you want the compilation jobs to connect to. For more information on controlling access to your Amazon S3 buckets used for compilation job, see Give Amazon SageMaker Compilation Jobs Access to Resources in Your Amazon VPC.

NestedFilters

A list of nested "Filter" objects. A resource must satisfy the conditions of all filters to be included in the results returned from the "Search" API.

NetworkConfig

Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

NotebookInstanceLifecycleConfigSummary

Provides a summary of a notebook instance lifecycle configuration.

NotebookInstanceLifecycleHook

Contains the notebook instance lifecycle configuration script.

NotebookInstanceSummary

Provides summary information for an SageMaker notebook instance.

NotificationConfiguration

Configures Amazon SNS notifications of available or expiring work items for work teams.

ObjectiveStatusCounters

Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.

OfflineStoreConfig

The configuration of an OfflineStore.

OfflineStoreStatus

The status of OfflineStore.

OidcConfig

Use this parameter to configure your OIDC Identity Provider (IdP).

OidcConfigForResponse

Your OIDC IdP workforce configuration.

OidcMemberDefinition

A list of user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

OnlineStoreConfig

Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or KMSKeyId, for at rest data encryption. You can turn OnlineStore on or off by specifying the EnableOnlineStore flag at General Assembly; the default value is False.

OnlineStoreSecurityConfig

The security configuration for OnlineStore.

OutputConfig

Contains information about the output location for the compiled model and the target device that the model runs on. TargetDevice and TargetPlatform are mutually exclusive, so you need to choose one between the two to specify your target device or platform. If you cannot find your device you want to use from the TargetDevice list, use TargetPlatform to describe the platform of your edge device and CompilerOptions if there are specific settings that are required or recommended to use for particular TargetPlatform.

OutputDataConfig

Provides information about how to store model training results (model artifacts).

OutputParameter

An output parameter of a pipeline step.

ParallelismConfiguration

Configuration that controls the parallelism of the pipeline. By default, the parallelism configuration specified applies to all executions of the pipeline unless overridden.

Parameter

Assigns a value to a named Pipeline parameter.

ParameterRange

Defines the possible values for categorical, continuous, and integer hyperparameters to be used by an algorithm.

ParameterRanges

Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.

Parent

The trial that a trial component is associated with and the experiment the trial is part of. A component might not be associated with a trial. A component can be associated with multiple trials.

ParentHyperParameterTuningJob

A previously completed or stopped hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

PendingDeploymentSummary

The summary of an in-progress deployment when an endpoint is creating or updating with a new endpoint configuration.

PendingProductionVariantSummary

The production variant summary for a deployment when an endpoint is creating or updating with the "CreateEndpoint" or "UpdateEndpoint" operations. Describes the VariantStatus, weight and capacity for a production variant associated with an endpoint.

Phase

Defines the traffic pattern.

Pipeline

A SageMaker Model Building Pipeline instance.

PipelineDefinitionS3Location

The location of the pipeline definition stored in Amazon S3.

PipelineExecution

An execution of a pipeline.

PipelineExecutionStep

An execution of a step in a pipeline.

PipelineExecutionStepMetadata

Metadata for a step execution.

PipelineExecutionSummary

A pipeline execution summary.

PipelineExperimentConfig

Specifies the names of the experiment and trial created by a pipeline.

PipelineSummary

A summary of a pipeline.

ProcessingClusterConfig

Configuration for the cluster used to run a processing job.

ProcessingFeatureStoreOutput

Configuration for processing job outputs in Amazon SageMaker Feature Store.

ProcessingInput

The inputs for a processing job. The processing input must specify exactly one of either S3Input or DatasetDefinition types.

ProcessingJob

An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, see Process Data and Evaluate Models.

ProcessingJobStepMetadata

Metadata for a processing job step.

ProcessingJobSummary

Summary of information about a processing job.

ProcessingOutput

Describes the results of a processing job. The processing output must specify exactly one of either S3Output or FeatureStoreOutput types.

ProcessingOutputConfig

Configuration for uploading output from the processing container.

ProcessingResources

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

ProcessingS3Input

Configuration for downloading input data from Amazon S3 into the processing container.

ProcessingS3Output

Configuration for uploading output data to Amazon S3 from the processing container.

ProcessingStoppingCondition

Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. After the condition is met, the processing job is stopped.

ProductionVariant

Identifies a model that you want to host and the resources chosen to deploy for hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic among the models by specifying variant weights.

ProductionVariantCoreDumpConfig

Specifies configuration for a core dump from the model container when the process crashes.

ProductionVariantServerlessConfig

Specifies the serverless configuration for an endpoint variant.

ProductionVariantStatus

Describes the status of the production variant.

ProductionVariantSummary

Describes weight and capacities for a production variant associated with an endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities API and the endpoint status is Updating, you get different desired and current values.

ProfilerConfig

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

ProfilerConfigForUpdate

Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and storage paths.

ProfilerRuleConfiguration

Configuration information for profiling rules.

ProfilerRuleEvaluationStatus

Information about the status of the rule evaluation.

Project

The properties of a project as returned by the Search API.

ProjectSummary

Information about a project.

PropertyNameQuery

Part of the SuggestionQuery type. Specifies a hint for retrieving property names that begin with the specified text.

PropertyNameSuggestion

A property name returned from a GetSearchSuggestions call that specifies a value in the PropertyNameQuery field.

ProvisioningParameter

A key value pair used when you provision a project as a service catalog product. For information, see What is Amazon Web Services Service Catalog.

PublicWorkforceTaskPrice

Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.

PutModelPackageGroupPolicyInput
PutModelPackageGroupPolicyOutput
QualityCheckStepMetadata

Container for the metadata for a Quality check step. For more information, see the topic on QualityCheck step in the Amazon SageMaker Developer Guide.

QueryFilters

A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the QueryLineage API action.

QueryLineageRequest
QueryLineageResponse
RealTimeInferenceConfig

The infrastructure configuration for deploying the model to a real-time inference endpoint.

RecommendationJobCompiledOutputConfig

Provides information about the output configuration for the compiled model.

RecommendationJobContainerConfig

Specifies mandatory fields for running an Inference Recommender job directly in the CreateInferenceRecommendationsJob API. The fields specified in ContainerConfig override the corresponding fields in the model package. Use ContainerConfig if you want to specify these fields for the recommendation job but don't want to edit them in your model package.

RecommendationJobInferenceBenchmark

The details for a specific benchmark from an Inference Recommender job.

RecommendationJobInputConfig

The input configuration of the recommendation job.

RecommendationJobOutputConfig

Provides information about the output configuration for the compiled model.

RecommendationJobPayloadConfig

The configuration for the payload for a recommendation job.

RecommendationJobResourceLimit

Specifies the maximum number of jobs that can run in parallel and the maximum number of jobs that can run.

RecommendationJobStoppingConditions

Specifies conditions for stopping a job. When a job reaches a stopping condition limit, SageMaker ends the job.

RecommendationJobVpcConfig

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

RecommendationMetrics

The metrics of recommendations.

RedshiftDatasetDefinition

Configuration for Redshift Dataset Definition input.

RegisterDevicesRequest
RegisterModelStepMetadata

Metadata for a register model job step.

RenderableTask

Contains input values for a task.

RenderingError

A description of an error that occurred while rendering the template.

RenderUiTemplateRequest
RenderUiTemplateResponse
RepositoryAuthConfig

Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field of the ImageConfig object that you passed to a call to CreateModel and the private Docker registry where the model image is hosted requires authentication.

ResolvedAttributes

The resolved attributes.

ResourceConfig

Describes the resources, including machine learning (ML) compute instances and ML storage volumes, to use for model training.

ResourceConfigForUpdate

The ResourceConfig to update KeepAlivePeriodInSeconds. Other fields in the ResourceConfig cannot be updated.

ResourceLimits

Specifies the maximum number of training jobs and parallel training jobs that a hyperparameter tuning job can launch.

ResourceSpec

Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

RetentionPolicy

The retention policy for data stored on an Amazon Elastic File System (EFS) volume.

RetryPipelineExecutionRequest
RetryPipelineExecutionResponse
RetryStrategy

The retry strategy to use when a training job fails due to an InternalServerError. RetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob requests. You can add the StoppingCondition parameter to the request to limit the training time for the complete job.

RSessionAppSettings

A collection of settings that apply to an RSessionGateway app.

RStudioServerProAppSettings

A collection of settings that configure user interaction with the RStudioServerPro app. RStudioServerProAppSettings cannot be updated. The RStudioServerPro app must be deleted and a new one created to make any changes.

RStudioServerProDomainSettings

A collection of settings that configure the RStudioServerPro Domain-level app.

RStudioServerProDomainSettingsForUpdate

A collection of settings that update the current configuration for the RStudioServerPro Domain-level app.

S3DataSource

Describes the S3 data source.

S3StorageConfig

The Amazon Simple Storage (Amazon S3) location and and security configuration for OfflineStore.

ScheduleConfig

Configuration details about the monitoring schedule.

SearchExpression

A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.

SearchRecord

A single resource returned as part of the "Search" API response.

SearchRequest
SearchResponse
SecondaryStatusTransition

An array element of "DescribeTrainingJobResponse$SecondaryStatusTransitions". It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.

SendPipelineExecutionStepFailureRequest
SendPipelineExecutionStepFailureResponse
SendPipelineExecutionStepSuccessRequest
SendPipelineExecutionStepSuccessResponse
ServiceCatalogProvisionedProductDetails

Details of a provisioned service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

ServiceCatalogProvisioningDetails

Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

ServiceCatalogProvisioningUpdateDetails

Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

ShadowModeConfig

The configuration of ShadowMode inference experiment type, which specifies a production variant to take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.

ShadowModelVariantConfig

The name and sampling percentage of a shadow variant.

SharingSettings

Specifies options for sharing SageMaker Studio notebooks. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called. When SharingSettings is not specified, notebook sharing isn't allowed.

ShuffleConfig

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, the results of the S3 key prefix matches are shuffled. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

SourceAlgorithm

Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

SourceAlgorithmSpecification

A list of algorithms that were used to create a model package.

SourceIpConfig

A list of IP address ranges (CIDRs). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to login to their worker portal from an IP address within this range. By default, a workforce isn't restricted to specific IP addresses.

SpaceDetails

The space's details.

SpaceSettings

A collection of space settings.

StartEdgeDeploymentStageRequest
StartInferenceExperimentRequest
StartInferenceExperimentResponse
StartMonitoringScheduleRequest
StartNotebookInstanceInput
StartPipelineExecutionRequest
StartPipelineExecutionResponse
StopAutoMLJobRequest
StopCompilationJobRequest
StopEdgeDeploymentStageRequest
StopEdgePackagingJobRequest
StopHyperParameterTuningJobRequest
StopInferenceExperimentRequest
StopInferenceExperimentResponse
StopInferenceRecommendationsJobRequest
StopLabelingJobRequest
StopMonitoringScheduleRequest
StopNotebookInstanceInput
StoppingCondition

Specifies a limit to how long a model training job or model compilation job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training or compilation job. Use this API to cap model training costs.

StopPipelineExecutionRequest
StopPipelineExecutionResponse
StopProcessingJobRequest
StopTrainingJobRequest
StopTransformJobRequest
StudioLifecycleConfigDetails

Details of the Studio Lifecycle Configuration.

SubscribedWorkteam

Describes a work team of a vendor that does the a labelling job.

SuggestionQuery

Specified in the "GetSearchSuggestions" request. Limits the property names that are included in the response.

Tag

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

TargetPlatform

Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.

TensorBoardAppSettings

The TensorBoard app settings.

TensorBoardOutputConfig

Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.

TimeSeriesForecastingSettings

Time series forecast settings for the SageMaker Canvas app.

TrafficPattern

Defines the traffic pattern of the load test.

TrafficRoutingConfig

Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.

TrainingImageConfig

The configuration to use an image from a private Docker registry for a training job.

TrainingJob

Contains information about a training job.

TrainingJobDefinition

Defines the input needed to run a training job using the algorithm.

TrainingJobStatusCounters

The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.

TrainingJobStepMetadata

Metadata for a training job step.

TrainingJobSummary

Provides summary information about a training job.

TrainingRepositoryAuthConfig

An object containing authentication information for a private Docker registry.

TrainingSpecification

Defines how the algorithm is used for a training job.

TransformDataSource

Describes the location of the channel data.

TransformInput

Describes the input source of a transform job and the way the transform job consumes it.

TransformJob

A batch transform job. For information about SageMaker batch transform, see Use Batch Transform.

TransformJobDefinition

Defines the input needed to run a transform job using the inference specification specified in the algorithm.

TransformJobStepMetadata

Metadata for a transform job step.

TransformJobSummary

Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a "ListTransformJobs" call.

TransformOutput

Describes the results of a transform job.

TransformResources

Describes the resources, including ML instance types and ML instance count, to use for transform job.

TransformS3DataSource

Describes the S3 data source.

Trial

The properties of a trial as returned by the "Search" API.

TrialComponent

The properties of a trial component as returned by the "Search" API.

TrialComponentArtifact

Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the "CreateTrialComponent" request.

TrialComponentMetricSummary

A summary of the metrics of a trial component.

TrialComponentParameterValue

The value of a hyperparameter. Only one of NumberValue or StringValue can be specified.

TrialComponentSimpleSummary

A short summary of a trial component.

TrialComponentSource

The Amazon Resource Name (ARN) and job type of the source of a trial component.

TrialComponentSourceDetail

Detailed information about the source of a trial component. Either ProcessingJob or TrainingJob is returned.

TrialComponentStatus

The status of the trial component.

TrialComponentSummary

A summary of the properties of a trial component. To get all the properties, call the "DescribeTrialComponent" API and provide the TrialComponentName.

TrialSource

The source of the trial.

TrialSummary

A summary of the properties of a trial. To get the complete set of properties, call the "DescribeTrial" API and provide the TrialName.

TuningJobCompletionCriteria

The job completion criteria.

TuningJobStepMetaData

Metadata for a tuning step.

UiConfig

Provided configuration information for the worker UI for a labeling job. Provide either HumanTaskUiArn or UiTemplateS3Uri.

UiTemplate

The Liquid template for the worker user interface.

UiTemplateInfo

Container for user interface template information.

UpdateActionRequest
UpdateActionResponse
UpdateAppImageConfigRequest
UpdateAppImageConfigResponse
UpdateArtifactRequest
UpdateArtifactResponse
UpdateCodeRepositoryInput
UpdateCodeRepositoryOutput
UpdateContextRequest
UpdateContextResponse
UpdateDeviceFleetRequest
UpdateDevicesRequest
UpdateDomainRequest
UpdateDomainResponse
UpdateEndpointInput
UpdateEndpointOutput
UpdateEndpointWeightsAndCapacitiesInput
UpdateEndpointWeightsAndCapacitiesOutput
UpdateExperimentRequest
UpdateExperimentResponse
UpdateFeatureGroupRequest
UpdateFeatureGroupResponse
UpdateFeatureMetadataRequest
UpdateHubRequest
UpdateHubResponse
UpdateImageRequest
UpdateImageResponse
UpdateImageVersionRequest
UpdateImageVersionResponse
UpdateInferenceExperimentRequest
UpdateInferenceExperimentResponse
UpdateModelCardRequest
UpdateModelCardResponse
UpdateModelPackageInput
UpdateModelPackageOutput
UpdateMonitoringAlertRequest
UpdateMonitoringAlertResponse
UpdateMonitoringScheduleRequest
UpdateMonitoringScheduleResponse
UpdateNotebookInstanceInput
UpdateNotebookInstanceLifecycleConfigInput
UpdatePipelineExecutionRequest
UpdatePipelineExecutionResponse
UpdatePipelineRequest
UpdatePipelineResponse
UpdateProjectInput
UpdateProjectOutput
UpdateSpaceRequest
UpdateSpaceResponse
UpdateTrainingJobRequest
UpdateTrainingJobResponse
UpdateTrialComponentRequest
UpdateTrialComponentResponse
UpdateTrialRequest
UpdateTrialResponse
UpdateUserProfileRequest
UpdateUserProfileResponse
UpdateWorkforceRequest
UpdateWorkforceResponse
UpdateWorkteamRequest
UpdateWorkteamResponse
USD

Represents an amount of money in United States dollars.

UserContext

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

UserProfileDetails

The user profile details.

UserSettings

A collection of settings that apply to users of Amazon SageMaker Studio. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.

VariantProperty

Specifies a production variant property type for an Endpoint.

Vertex

A lineage entity connected to the starting entity(ies).

VpcConfig

Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Training Jobs by Using an Amazon Virtual Private Cloud.

WarmPoolStatus

Status and billing information about the warm pool.

Workforce

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

WorkforceVpcConfigRequest

The VPC object you use to create or update a workforce.

WorkforceVpcConfigResponse

A VpcConfig object that specifies the VPC that you want your workforce to connect to.

Workteam

Provides details about a labeling work team.

§Type Aliases

ActionStatus
AlgorithmSortBy
AlgorithmStatus
AppImageConfigSortKey
AppInstanceType
AppNetworkAccessType
AppSecurityGroupManagement
AppSortKey
AppStatus
AppType
ArtifactSourceIdType
AssemblyType
AssociationEdgeType
AthenaResultCompressionType

The compression used for Athena query results.

AthenaResultFormat

The data storage format for Athena query results.

AuthMode
AutoMLAlgorithm
AutoMLChannelType
AutoMLJobObjectiveType
AutoMLJobSecondaryStatus
AutoMLJobStatus
AutoMLMetricEnum
AutoMLMetricExtendedEnum
AutoMLMode
AutoMLS3DataType
AutoMLSortBy
AutoMLSortOrder
AwsManagedHumanLoopRequestSource
BatchStrategy
BooleanOperator
CandidateSortBy
CandidateStatus
CandidateStepType
CapacitySizeType
CaptureMode
CaptureStatus
ClarifyFeatureType
ClarifyTextGranularity
ClarifyTextLanguage
CodeRepositorySortBy
CodeRepositorySortOrder
CompilationJobStatus
CompleteOnConvergence
CompressionType
ConditionOutcome
ContainerMode
ContentClassifier
DataDistributionType
DetailedAlgorithmStatus
DetailedModelPackageStatus
DeviceDeploymentStatus
DeviceSubsetType
DirectInternetAccess
Direction
DomainStatus
EdgePackagingJobStatus
EdgePresetDeploymentStatus
EdgePresetDeploymentType
EndpointConfigSortKey
EndpointSortKey
EndpointStatus
ExecutionRoleIdentityConfig
ExecutionStatus
FailureHandlingPolicy
FeatureGroupSortBy
FeatureGroupSortOrder
FeatureGroupStatus
FeatureStatus
FeatureType
FileSystemAccessMode
FileSystemType
FlowDefinitionStatus
Framework
HubContentSortBy
HubContentStatus
HubContentType
HubSortBy
HubStatus
HumanTaskUiStatus
HyperParameterScalingType
HyperParameterTuningAllocationStrategy
HyperParameterTuningJobObjectiveType
HyperParameterTuningJobSortByOptions
HyperParameterTuningJobStatus
HyperParameterTuningJobStrategyType

The strategy hyperparameter tuning uses to find the best combination of hyperparameters for your model.

HyperParameterTuningJobWarmStartType
ImageSortBy
ImageSortOrder
ImageStatus
ImageVersionSortBy
ImageVersionSortOrder
ImageVersionStatus
InferenceExecutionMode
InferenceExperimentStatus
InferenceExperimentStopDesiredState
InferenceExperimentType
InputMode
InstanceType
JobType
JoinSource
LabelingJobStatus
LastUpdateStatusValue
LineageType
ListCompilationJobsSortBy
ListDeviceFleetsSortBy
ListEdgeDeploymentPlansSortBy
ListEdgePackagingJobsSortBy
ListInferenceRecommendationsJobsSortBy
ListLabelingJobsForWorkteamSortByOptions
ListWorkforcesSortByOptions
ListWorkteamsSortByOptions
MetricSetSource
ModelApprovalStatus
ModelCacheSetting
ModelCardExportJobSortBy

Attribute by which to sort returned export jobs.

ModelCardExportJobSortOrder
ModelCardExportJobStatus
ModelCardProcessingStatus
ModelCardSortBy
ModelCardSortOrder
ModelCardStatus
ModelCardVersionSortBy
ModelInfrastructureType
ModelMetadataFilterType
ModelPackageGroupSortBy
ModelPackageGroupStatus
ModelPackageSortBy
ModelPackageStatus
ModelPackageType
ModelSortKey
ModelVariantAction
ModelVariantStatus
MonitoringAlertHistorySortKey
MonitoringAlertStatus
MonitoringExecutionSortKey
MonitoringJobDefinitionSortKey
MonitoringProblemType
MonitoringScheduleSortKey
MonitoringType
NotebookInstanceAcceleratorType
NotebookInstanceLifecycleConfigSortKey
NotebookInstanceLifecycleConfigSortOrder
NotebookInstanceSortKey
NotebookInstanceSortOrder
NotebookInstanceStatus
NotebookOutputOption
ObjectiveStatus
OfflineStoreStatusValue
Operator
OrderKey
ParameterType
PipelineExecutionStatus
PipelineStatus
ProblemType
ProcessingInstanceType
ProcessingJobStatus
ProcessingS3CompressionType
ProcessingS3DataDistributionType
ProcessingS3DataType
ProcessingS3InputMode
ProcessingS3UploadMode
Processor
ProductionVariantAcceleratorType
ProductionVariantInstanceType
ProfilingStatus
ProjectSortBy
ProjectSortOrder
ProjectStatus
RecommendationJobStatus
RecommendationJobType
RecommendationStepType
RecordWrapper
RedshiftResultCompressionType

The compression used for Redshift query results.

RedshiftResultFormat

The data storage format for Redshift query results.

RepositoryAccessMode
ResourceType
RetentionType
RootAccess
RStudioServerProAccessStatus
RStudioServerProUserGroup
RuleEvaluationStatus
S3DataDistribution
S3DataType
SagemakerServicecatalogStatus
ScheduleStatus
SearchSortOrder
SecondaryStatus
SortActionsBy
SortArtifactsBy
SortAssociationsBy
SortBy
SortContextsBy
SortExperimentsBy
SortInferenceExperimentsBy
SortLineageGroupsBy
SortOrder
SortPipelineExecutionsBy
SortPipelinesBy
SortTrialComponentsBy
SortTrialsBy
SpaceSortKey
SpaceStatus
SplitType
StageStatus
StepStatus
StudioLifecycleConfigAppType
StudioLifecycleConfigSortKey
TableFormat
TargetDevice
TargetPlatformAccelerator
TargetPlatformArch
TargetPlatformOs
TrafficRoutingConfigType
TrafficType
TrainingInputMode

The training input mode that the algorithm supports. For more information about input modes, see Algorithms.

TrainingInstanceType
TrainingJobEarlyStoppingType
TrainingJobSortByOptions
TrainingJobStatus
TrainingRepositoryAccessMode
TransformInstanceType
TransformJobStatus
TrialComponentPrimaryStatus
UserProfileSortKey
UserProfileStatus
VariantPropertyType
VariantStatus
VendorGuidance
WarmPoolResourceStatus
WorkforceStatus