Module types

Source
Expand description

Data structures used by operation inputs/outputs.

Modules§

builders
Builders
error
Error types that Amazon SageMaker Service can respond with.

Structs§

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.

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

AdditionalModelDataSource

Data sources that are available to your model in addition to the one that you specify for ModelDataSource when you use the CreateModel action.

AdditionalS3DataSource

A data source used for training or inference that is in addition to the input dataset or model data.

AgentVersion

Edge Manager agent version.

Alarm

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

AlarmDetails

The details of the alarm to monitor during the AMI update.

AlgorithmSpecification

Specifies the training algorithm to use in a CreateTrainingJob request.

SageMaker uses its own SageMaker account credentials to pull and access built-in algorithms so built-in algorithms are universally accessible across all Amazon Web Services accounts. As a result, built-in algorithms have standard, unrestricted access. You cannot restrict built-in algorithms using IAM roles. Use custom algorithms if you require specific access controls.

For more information about algorithms provided by SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

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.

The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.

AlgorithmValidationSpecification

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

AmazonQSettings

A collection of settings that configure the Amazon Q experience within the domain.

AnnotationConsolidationConfig

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

AppDetails

Details about an Amazon SageMaker AI app.

AppImageConfigDetails

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

AppLifecycleManagement

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications.

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.

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 selection of algorithms trained on your dataset to generate the model candidates for 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 Channel.

A validation dataset must contain the same headers as the training dataset.

AutoMlComputeConfig

This data type is intended for use exclusively by SageMaker Canvas and cannot be used in other contexts at the moment.

Specifies the compute configuration for an AutoML job V2.

AutoMlContainerDefinition

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

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. For jobs created by calling CreateAutoMLJob, the validation dataset must be less than 2 GB in size.

AutoMlJobArtifacts

The artifacts that are generated during an AutoML job.

AutoMlJobChannel

A channel is a named input source that training algorithms can consume. This channel is used for AutoML jobs V2 (jobs created by calling CreateAutoMLJobV2).

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 an AutoML 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.

AutoMlResolvedAttributes

The resolved attributes used to configure an AutoML job V2.

AutoMlSecurityConfig

Security options.

AutoMls3DataSource

Describes the Amazon S3 data source.

AutoParameter

The name and an example value of the hyperparameter that you want to use in Autotune. If Automatic model tuning (AMT) determines that your hyperparameter is eligible for Autotune, an optimal hyperparameter range is selected for you.

AutoRollbackConfig

Automatic rollback configuration for handling endpoint deployment failures and recovery.

Autotune

A flag to indicate if you want to use Autotune to automatically find optimal values for the following fields:

  • ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.

  • ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.

  • TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.

  • RetryStrategy: The number of times to retry a training job.

  • Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.

  • ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.

BatchDataCaptureConfig

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

BatchDeleteClusterNodesError

Represents an error encountered when deleting a node from a SageMaker HyperPod cluster.

BatchDescribeModelPackageError

The error code and error description associated with the resource.

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.

CandidateGenerationConfig

Stores the configuration information for how model candidates are generated using an AutoML job V2.

CandidateProperties

The properties of an AutoML candidate job.

CanvasAppSettings

The SageMaker Canvas application settings.

CapacitySize

Specifies the type and size of the endpoint capacity to activate for a blue/green deployment, a rolling deployment, or a rollback strategy. You can specify your batches as either instance count or the overall percentage or your fleet.

For a rollback strategy, if you don't specify the fields in this object, or if you set the Value to 100%, then SageMaker uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.

CapacitySizeConfig

The configuration of the size measurements of the AMI update. Using this configuration, you can specify whether SageMaker should update your instance group by an amount or percentage of instances.

CaptureContentTypeHeader

Configuration specifying how to treat different headers. If no headers are specified Amazon SageMaker AI 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.

  • The number of records in the baseline data determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.

  • ShapBaseline and ShapBaselineUri are mutually exclusive parameters. One or the either is required to configure a SHAP baseline.

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.

ClusterEbsVolumeConfig

Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS) volume to each instance of the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.

ClusterInstanceGroupDetails

Details of an instance group in a SageMaker HyperPod cluster.

ClusterInstanceGroupSpecification

The specifications of an instance group that you need to define.

ClusterInstancePlacement

Specifies the placement details for the node in the SageMaker HyperPod cluster, including the Availability Zone and the unique identifier (ID) of the Availability Zone.

ClusterInstanceStatusDetails

Details of an instance in a SageMaker HyperPod cluster.

ClusterLifeCycleConfig

The lifecycle configuration for a SageMaker HyperPod cluster.

ClusterNodeDetails

Details of an instance (also called a node interchangeably) in a SageMaker HyperPod cluster.

ClusterNodeSummary

Lists a summary of the properties of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

ClusterOrchestrator

The type of orchestrator used for the SageMaker HyperPod cluster.

ClusterOrchestratorEksConfig

The configuration settings for the Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.

ClusterSchedulerConfigSummary

Summary of the cluster policy.

ClusterSummary

Lists a summary of the properties of a SageMaker HyperPod cluster.

CodeEditorAppImageConfig

The configuration for the file system and kernels in a SageMaker image running as a Code Editor app. The FileSystemConfig object is not supported.

CodeEditorAppSettings

The Code Editor application settings.

For more information about Code Editor, see Get started with Code Editor in Amazon SageMaker.

CodeRepository

A Git repository that SageMaker AI 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.

ComputeQuotaConfig

Configuration of the compute allocation definition for an entity. This includes the resource sharing option and the setting to preempt low priority tasks.

ComputeQuotaResourceConfig

Configuration of the resources used for the compute allocation definition.

ComputeQuotaSummary

Summary of the compute allocation definition.

ComputeQuotaTarget

The target entity to allocate compute resources to.

ConditionStepMetadata

Metadata for a Condition step.

ContainerConfig

The configuration used to run the application image container.

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.

CustomImage

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

CustomPosixUserConfig

Details about the POSIX identity that is used for file system operations.

CustomizedMetricSpecification

A customized metric.

DataCaptureConfig

Configuration to control how SageMaker AI 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.

DataSource

Describes the location of the channel data.

DatasetDefinition

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

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.

DefaultEbsStorageSettings

A collection of default EBS storage settings that apply to spaces created within a domain or user profile.

DefaultSpaceSettings

The default settings for shared spaces that users create in the domain.

SageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces.

DefaultSpaceStorageSettings

The default storage settings for a space.

DeployedImage

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

If you used the registry/repository\[:tag\] form to specify the image path of the primary container when you created the model hosted in this ProductionVariant, the path resolves to a path of the form registry/repository\[@digest\]. A digest is a hash value that identifies a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.

DeploymentConfig

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

DeploymentConfiguration

The configuration to use when updating the AMI versions.

DeploymentRecommendation

A set of recommended deployment configurations for the model. To get more advanced recommendations, see CreateInferenceRecommendationsJob to create an inference recommendation job.

DeploymentStage

Contains information about a stage in an edge deployment plan.

DeploymentStageStatusSummary

Contains information summarizing the deployment stage results.

DerivedInformation

Information that SageMaker Neo automatically derived about the model.

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.

DirectDeploySettings

The model deployment settings for the SageMaker Canvas application.

In order to enable model deployment for Canvas, the SageMaker Domain's or user profile's Amazon Web Services IAM execution role must have the AmazonSageMakerCanvasDirectDeployAccess policy attached. You can also turn on model deployment permissions through the SageMaker Domain's or user profile's settings in the SageMaker console.

DockerSettings

A collection of settings that configure the domain's Docker interaction.

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.

DynamicScalingConfiguration

An object with the recommended values for you to specify when creating an autoscaling policy.

EbsStorageSettings

A collection of EBS storage settings that apply to both private and shared spaces.

Ec2CapacityReservation

The EC2 capacity reservations that are shared to an ML capacity reservation.

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.

EfsFileSystem

A file system, created by you in Amazon EFS, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

EfsFileSystemConfig

The settings for assigning a custom Amazon EFS file system to a user profile or space for an Amazon SageMaker AI Domain.

EmrServerlessComputeConfig

This data type is intended for use exclusively by SageMaker Canvas and cannot be used in other contexts at the moment.

Specifies the compute configuration for the EMR Serverless job.

EmrServerlessSettings

The settings for running Amazon EMR Serverless jobs in SageMaker Canvas.

EmrSettings

The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.

EmrStepMetadata

The configurations and outcomes of an Amazon EMR step execution.

Endpoint

A hosted endpoint for real-time inference.

EndpointConfigStepMetadata

Metadata for an endpoint configuration step.

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.

EndpointStepMetadata

Metadata for an endpoint step.

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

ErrorInfo

This is an error field object that contains the error code and the reason for an operation failure.

Experiment

The properties of an experiment as returned by the Search API. For information about experiments, see the CreateExperiment 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.

FSxLustreFileSystem

A custom file system in Amazon FSx for Lustre.

FSxLustreFileSystemConfig

The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an Amazon SageMaker Domain.

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 storage configuration for a SageMaker AI 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.

If you specify a Value, but not an Operator, SageMaker uses the equals operator.

In search, there are several property types:

Metrics

To define a metric filter, enter a value using the form "Metrics.<name>", where <name> is a metric name. For example, the following filter searches for training jobs with an "accuracy" metric greater than "0.9":

{

"Name": "Metrics.accuracy",

"Operator": "GreaterThan",

"Value": "0.9"

}

HyperParameters

To define a hyperparameter filter, enter a value with the form "HyperParameters.<name>". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a "learning_rate" hyperparameter that is less than "0.5":

{

"Name": "HyperParameters.learning_rate",

"Operator": "LessThan",

"Value": "0.5"

}

Tags

To define a tag filter, enter a value with the form Tags.<key>.

FinalAutoMlJobObjectiveMetric

The best candidate result from an AutoML training job.

FinalHyperParameterTuningJobObjectiveMetric

Shows the latest objective metric emitted by 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.

GenerativeAiSettings

The generative AI settings for the SageMaker Canvas application.

Configure these settings for Canvas users starting chats with generative AI foundation models. For more information, see Use generative AI with foundation models.

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.

HiddenSageMakerImage

The SageMaker images that are hidden from the Studio user interface. You must specify the SageMaker image name and version aliases.

HolidayConfigAttributes

Stores the holiday featurization attributes applicable to each item of time-series datasets during the training of a forecasting model. This allows the model to identify patterns associated with specific holidays.

HubAccessConfig

The configuration for a private hub model reference that points to a public SageMaker JumpStart model.

For more information about private hubs, see Private curated hubs for foundation model access control in JumpStart.

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 CreateFlowDefinition. See HumanLoopActivationConditionsConfig 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.

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. If you want to define a custom objective metric, see Define metrics and environment variables.

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.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the 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.

HyperParameterTuningResourceConfig supports the capabilities of ResourceConfig with the exception of KeepAlivePeriodInSeconds. Hyperparameter tuning jobs use warm pools by default, which reuse clusters between training jobs.

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.

IamIdentity

The IAM Identity details associated with the user. These details are associated with model package groups, model packages and project entities only.

IamPolicyConstraints

Use this parameter to specify a supported global condition key that is added to the IAM policy.

IdentityProviderOAuthSetting

The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake.

IdleSettings

Settings related to idle shutdown of Studio applications.

Image

A SageMaker AI image. A SageMaker AI 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 AI ImageVersion.

ImageClassificationJobConfig

The collection of settings used by an AutoML job V2 for the image classification problem type.

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 AI Image. A version represents an existing container image.

InferenceComponentCapacitySize

Specifies the type and size of the endpoint capacity to activate for a rolling deployment or a rollback strategy. You can specify your batches as either of the following:

  • A count of inference component copies

  • The overall percentage or your fleet

For a rollback strategy, if you don't specify the fields in this object, or if you set the Value parameter to 100%, then SageMaker AI uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.

InferenceComponentComputeResourceRequirements

Defines the compute resources to allocate to run a model, plus any adapter models, that you assign to an inference component. These resources include CPU cores, accelerators, and memory.

InferenceComponentContainerSpecification

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

InferenceComponentContainerSpecificationSummary

Details about the resources that are deployed with this inference component.

InferenceComponentDeploymentConfig

The deployment configuration for an endpoint that hosts inference components. The configuration includes the desired deployment strategy and rollback settings.

InferenceComponentRollingUpdatePolicy

Specifies a rolling deployment strategy for updating a SageMaker AI inference component.

InferenceComponentRuntimeConfig

Runtime settings for a model that is deployed with an inference component.

InferenceComponentRuntimeConfigSummary

Details about the runtime settings for the model that is deployed with the inference component.

InferenceComponentSpecification

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

InferenceComponentSpecificationSummary

Details about the resources that are deployed with this inference component.

InferenceComponentStartupParameters

Settings that take effect while the model container starts up.

InferenceComponentSummary

A summary of the properties of an inference component.

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.

The maximum duration that you can set for an inference experiment is 30 days.

InferenceExperimentSummary

Lists a summary of properties of an inference experiment.

InferenceHubAccessConfig

Configuration information specifying which hub contents have accessible deployment options.

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.

InfraCheckConfig

Configuration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network connectivity.

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.

JupyterLabAppImageConfig

The configuration for the file system and kernels in a SageMaker AI image running as a JupyterLab app. The FileSystemConfig object is not supported.

JupyterLabAppSettings

The settings for the JupyterLab application.

JupyterServerAppSettings

The JupyterServer app settings.

KendraSettings

The Amazon SageMaker Canvas application setting where you configure document querying.

KernelGatewayAppSettings

The KernelGateway app settings.

KernelGatewayImageConfig

The configuration for the file system and kernels in a SageMaker AI 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.

You must specify at least one of the following: S3DataSource or SnsDataSource.

Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job.

Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

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.

Labeling jobs fail after 30 days with an appropriate client error message.

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.

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. You can view these logs to understand how your training job performs and check for any errors encountered during training. SageMaker hyperparameter tuning captures all defined metrics. Specify one of the defined metrics to use as an objective metric using the TuningObjective parameter in the HyperParameterTrainingJobDefinition API to evaluate job performance during hyperparameter tuning.

MetricsSource

Details about the metrics source.

Model

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

ModelAccessConfig

The access configuration file to control access to the ML model. You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig.

ModelArtifacts

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

Model artifacts are outputs that result from training a model. They typically consist of trained parameters, a model definition that describes how to compute inferences, and other metadata. A SageMaker container stores your trained model artifacts in the /opt/ml/model directory. After training has completed, by default, these artifacts are uploaded to your Amazon S3 bucket as compressed files.

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.

ModelCompilationConfig

Settings for the model compilation technique that's applied by a model optimization job.

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.

ModelDataSource

Specifies the location of ML model data to deploy. If specified, you must specify one and only one of the available data sources.

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.

ModelLifeCycle

A structure describing the current state of the model in its life cycle.

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 container for your trained model that can be deployed for SageMaker inference. This can include inference code, artifacts, and metadata. The model package type can be one of the following.

  • Versioned model: A part of a model package group in Model Registry.

  • Unversioned model: Not part of a model package group and used in Amazon Web Services Marketplace.

For more information, see CreateModelPackage .

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.

ModelPackageModelCard

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

ModelPackageSecurityConfig

An optional Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.

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.

The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.

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 endpoints are supported for input for model quality monitoring jobs.

ModelQuantizationConfig

Settings for the model quantization technique that's applied by a model optimization job.

ModelRegisterSettings

The model registry settings for the SageMaker Canvas application.

ModelShardingConfig

Settings for the model sharding technique that's applied by a model optimization job.

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

For example, to filter on a training job's InputDataConfig property with a specific channel name and S3Uri prefix, define the following filters:

  • '{Name:"InputDataConfig.ChannelName", "Operator":"Equals", "Value":"train"}',

  • '{Name:"InputDataConfig.DataSource.S3DataSource.S3Uri", "Operator":"Contains", "Value":"mybucket/catdata"}'

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.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream \[notebook-instance-name\]/\[LifecycleConfigHook\].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

NotebookInstanceSummary

Provides summary information for an SageMaker AI 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.

Provide an OfflineStoreConfig in a request to CreateFeatureGroup to create an OfflineStore.

To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in S3StorageConfig.

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.

OnlineStoreConfigUpdate

Updates the feature group online store configuration.

OnlineStoreSecurityConfig

The security configuration for OnlineStore.

OptimizationJobModelSource

The location of the source model to optimize with an optimization job.

OptimizationJobModelSourceS3

The Amazon S3 location of a source model to optimize with an optimization job.

OptimizationJobOutputConfig

Details for where to store the optimized model that you create with the optimization job.

OptimizationJobSummary

Summarizes an optimization job by providing some of its key properties.

OptimizationModelAccessConfig

The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).

OptimizationOutput

Output values produced by an optimization job.

OptimizationVpcConfig

A VPC in Amazon VPC that's accessible to an optimized that you create with an optimization job. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.

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.

OwnershipSettings

The collection of ownership settings for a space.

OwnershipSettingsSummary

Specifies summary information about the ownership settings.

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.

The maximum number of items specified for Array Members refers to the maximum number of hyperparameters for each range and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of hyperparameters for all the ranges can't exceed the maximum number specified.

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.

PartnerAppConfig

Configuration settings for the SageMaker Partner AI App.

PartnerAppMaintenanceConfig

Maintenance configuration settings for the SageMaker Partner AI App.

PartnerAppSummary

A subset of information related to a SageMaker Partner AI App. This information is used as part of the ListPartnerApps API response.

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.

PredefinedMetricSpecification

A specification for a predefined metric.

PriorityClass

Priority class configuration. When included in PriorityClasses, these class configurations define how tasks are queued.

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. For more information on production variants, check Production variants.

ProductionVariantCapacityReservationConfig

Settings for the capacity reservation for the compute instances that SageMaker AI reserves for an endpoint.

ProductionVariantCapacityReservationSummary

Details about an ML capacity reservation.

ProductionVariantCoreDumpConfig

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

ProductionVariantManagedInstanceScaling

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

ProductionVariantRoutingConfig

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

ProductionVariantServerlessConfig

Specifies the serverless configuration for an endpoint variant.

ProductionVariantServerlessUpdateConfig

Specifies the serverless update concurrency 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.

Use one of the following prices for bounding box tasks. Prices are in US dollars and should be based on the complexity of the task; the longer it takes in your initial testing, the more you should offer.

  • 0.036

  • 0.048

  • 0.060

  • 0.072

  • 0.120

  • 0.240

  • 0.360

  • 0.480

  • 0.600

  • 0.720

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.

  • 0.012

  • 0.024

  • 0.036

  • 0.048

  • 0.060

  • 0.072

  • 0.120

  • 0.240

  • 0.360

  • 0.480

  • 0.600

  • 0.720

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon Augmented AI review tasks. Prices are in US dollars.

  • 2.400

  • 2.280

  • 2.160

  • 2.040

  • 1.920

  • 1.800

  • 1.680

  • 1.560

  • 1.440

  • 1.320

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

Use one of the following prices for Rekognition DetectModerationLabels Amazon Augmented AI review tasks. Prices are in US dollars.

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

Use one of the following prices for Amazon Augmented AI custom human review tasks. Prices are in US dollars.

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

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.

RSessionAppSettings

A collection of settings that apply to an RSessionGateway app.

RStudioServerProAppSettings

A collection of settings that configure user interaction with the RStudioServerPro app.

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.

RealTimeInferenceConfig

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

RealTimeInferenceRecommendation

The recommended configuration to use for Real-Time Inference.

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.

RegisterModelStepMetadata

Metadata for a register model job step.

RemoteDebugConfig

Configuration for remote debugging for the CreateTrainingJob API. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

RemoteDebugConfigForUpdate

Configuration for remote debugging for the UpdateTrainingJob API. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

RenderableTask

Contains input values for a task.

RenderingError

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

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.

ReservedCapacityOffering

Details about a reserved capacity offering for a training plan offering.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

ReservedCapacitySummary

Details of a reserved capacity for the training plan.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

ResolvedAttributes

The resolved attributes.

ResourceCatalog

A resource catalog containing all of the resources of a specific resource type within a resource owner account. For an example on sharing the Amazon SageMaker Feature Store DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide.

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.

ResourceSharingConfig

Resource sharing configuration.

ResourceSpec

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

When both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn, pass None as the value.

RetentionPolicy

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

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.

RollingDeploymentPolicy

The configurations that SageMaker uses when updating the AMI versions.

RollingUpdatePolicy

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

S3DataSource

Describes the S3 data source.

Your input bucket must be in the same Amazon Web Services region as your training job.

S3ModelDataSource

Specifies the S3 location of ML model data to deploy.

S3Presign

This object defines the access restrictions to Amazon S3 resources that are included in custom worker task templates using the Liquid filter, grant_read_access.

To learn more about how custom templates are created, see Create custom worker task templates.

S3StorageConfig

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

ScalingPolicyMetric

The metric for a scaling policy.

ScalingPolicyObjective

An object where you specify the anticipated traffic pattern for an endpoint.

ScheduleConfig

Configuration details about the monitoring schedule.

ScheduledUpdateConfig

The configuration object of the schedule that SageMaker follows when updating the AMI.

SchedulerConfig

Cluster policy configuration. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.

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.

A SearchExpression contains the following components:

  • A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.

  • A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.

  • A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.

  • A Boolean operator: And or Or.

SearchRecord

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

SecondaryStatusTransition

An array element of SecondaryStatusTransitions for DescribeTrainingJob. 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.

SelectedStep

A step selected to run in selective execution mode.

SelectiveExecutionConfig

The selective execution configuration applied to the pipeline run.

SelectiveExecutionResult

The ARN from an execution of the current pipeline.

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.

SessionChainingConfig

Contains information about attribute-based access control (ABAC) for a training job. The session chaining configuration uses Amazon Security Token Service (STS) for your training job to request temporary, limited-privilege credentials to tenants. For more information, see Attribute-based access control (ABAC) for multi-tenancy training.

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 Amazon SageMaker AI 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.

For Pipe input mode, when ShuffleConfig is specified shuffling is done at the start of every epoch. With large datasets, this ensures that the order of the training data is different for each epoch, and it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

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 log in to their worker portal from an IP address within this range. By default, a workforce isn't restricted to specific IP addresses.

SpaceAppLifecycleManagement

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications in a space.

SpaceCodeEditorAppSettings

The application settings for a Code Editor space.

SpaceDetails

The space's details.

SpaceIdleSettings

Settings related to idle shutdown of Studio applications in a space.

SpaceJupyterLabAppSettings

The settings for the JupyterLab application within a space.

SpaceSettings

A collection of space settings.

SpaceSettingsSummary

Specifies summary information about the space settings.

SpaceSharingSettings

A collection of space sharing settings.

SpaceSharingSettingsSummary

Specifies summary information about the space sharing settings.

SpaceStorageSettings

The storage settings for a space.

Stairs

Defines the stairs traffic pattern for an Inference Recommender load test. This pattern type consists of multiple steps where the number of users increases at each step.

Specify either the stairs or phases traffic pattern.

StoppingCondition

Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.

To stop a training job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.

The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

StudioLifecycleConfigDetails

Details of the Amazon SageMaker AI Studio Lifecycle Configuration.

StudioWebPortalSettings

Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.

SubscribedWorkteam

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

SuggestionQuery

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

TabularJobConfig

The collection of settings used by an AutoML job V2 for the tabular problem type.

TabularResolvedAttributes

The resolved attributes specific to the tabular problem type.

Tag

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

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

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.

TargetTrackingScalingPolicyConfiguration

A target tracking scaling policy. Includes support for predefined or customized metrics.

When using the PutScalingPolicy API, this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.

TensorBoardAppSettings

The TensorBoard app settings.

TensorBoardOutputConfig

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

TextClassificationJobConfig

The collection of settings used by an AutoML job V2 for the text classification problem type.

TextGenerationJobConfig

The collection of settings used by an AutoML job V2 for the text generation problem type.

The text generation models that support fine-tuning in Autopilot are currently accessible exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported Regions.

TextGenerationResolvedAttributes

The resolved attributes specific to the text generation problem type.

ThroughputConfig

Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

ThroughputConfigDescription

Active throughput configuration of the feature group. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

ThroughputConfigUpdate

The new throughput configuration for the feature group. You can switch between on-demand and provisioned modes or update the read / write capacity of provisioned feature groups. You can switch a feature group to on-demand only once in a 24 hour period.

TimeSeriesConfig

The collection of components that defines the time-series.

TimeSeriesForecastingJobConfig

The collection of settings used by an AutoML job V2 for the time-series forecasting problem type.

TimeSeriesForecastingSettings

Time series forecast settings for the SageMaker Canvas application.

TimeSeriesTransformations

Transformations allowed on the dataset. Supported transformations are Filling and Aggregation. Filling specifies how to add values to missing values in the dataset. Aggregation defines how to aggregate data that does not align with forecast frequency.

TotalHits

Represents the total number of matching results and indicates how accurate that count is.

The Value field provides the count, which may be exact or estimated. The Relation field indicates whether it's an exact figure or a lower bound. This helps understand the full scope of search results, especially when dealing with large result sets.

TrackingServerSummary

The summary of the tracking server to list.

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.

TrainingPlanFilter

A filter to apply when listing or searching for training plans.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

TrainingPlanOffering

Details about a training plan offering.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

TrainingPlanSummary

Details of the training plan.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

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.

Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

TrialComponentMetricSummary

A summary of the metrics of a trial component.

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.

TtlDuration

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

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.

For named entity recognition, 3D point cloud and video frame labeling jobs, use HumanTaskUiArn.

For all other Ground Truth built-in task types and custom task types, use UiTemplateS3Uri to specify the location of a worker task template in Amazon S3.

UiTemplate

The Liquid template for the worker user interface.

UiTemplateInfo

Container for user interface template information.

UnifiedStudioSettings

The settings that apply to an Amazon SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

UpdateClusterSoftwareInstanceGroupSpecification

The configuration that describes specifications of the instance groups to update.

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 in a domain. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

VariantProperty

Specifies a production variant property type for an Endpoint.

If you are updating an endpoint with the RetainAllVariantProperties option of UpdateEndpointInput set to true, the VariantProperty objects listed in the ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the endpoint.

VectorConfig

Configuration for your vector collection type.

Vertex

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

VisibilityConditions

The list of key-value pairs used to filter your search results. If a search result contains a key from your list, it is included in the final search response if the value associated with the key in the result matches the value you specified. If the value doesn't match, the result is excluded from the search response. Any resources that don't have a key from the list that you've provided will also be included in the search response.

VpcConfig

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.

WarmPoolStatus

Status and billing information about the warm pool.

WorkerAccessConfiguration

Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.

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.

WorkspaceSettings

The workspace settings for the SageMaker Canvas application.

Workteam

Provides details about a labeling work team.

Enums§

ActionStatus
When writing a match expression against ActionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ActivationState
When writing a match expression against ActivationState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AdditionalS3DataSourceDataType
When writing a match expression against AdditionalS3DataSourceDataType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AggregationTransformationValue
When writing a match expression against AggregationTransformationValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AlgorithmSortBy
When writing a match expression against AlgorithmSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AlgorithmStatus
When writing a match expression against AlgorithmStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AppImageConfigSortKey
When writing a match expression against AppImageConfigSortKey, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AppInstanceType
When writing a match expression against AppInstanceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AppNetworkAccessType
When writing a match expression against AppNetworkAccessType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AppSecurityGroupManagement
When writing a match expression against AppSecurityGroupManagement, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AppSortKey
When writing a match expression against AppSortKey, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AppStatus
When writing a match expression against AppStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AppType
When writing a match expression against AppType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ArtifactSourceIdType
When writing a match expression against ArtifactSourceIdType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AssemblyType
When writing a match expression against AssemblyType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AssociationEdgeType
When writing a match expression against AssociationEdgeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AsyncNotificationTopicTypes
When writing a match expression against AsyncNotificationTopicTypes, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AthenaResultCompressionType
When writing a match expression against AthenaResultCompressionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AthenaResultFormat
When writing a match expression against AthenaResultFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AuthMode
When writing a match expression against AuthMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AutoMlAlgorithm
When writing a match expression against AutoMlAlgorithm, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AutoMlChannelType
When writing a match expression against AutoMlChannelType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AutoMlJobObjectiveType
When writing a match expression against AutoMlJobObjectiveType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AutoMlJobSecondaryStatus
When writing a match expression against AutoMlJobSecondaryStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AutoMlJobStatus
When writing a match expression against AutoMlJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AutoMlMetricEnum
When writing a match expression against AutoMlMetricEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AutoMlMetricExtendedEnum
When writing a match expression against AutoMlMetricExtendedEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AutoMlMode
When writing a match expression against AutoMlMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AutoMlProblemTypeConfig

A collection of settings specific to the problem type used to configure an AutoML job V2. There must be one and only one config of the following type.

AutoMlProblemTypeConfigName
When writing a match expression against AutoMlProblemTypeConfigName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AutoMlProblemTypeResolvedAttributes

Stores resolved attributes specific to the problem type of an AutoML job V2.

AutoMlProcessingUnit
When writing a match expression against AutoMlProcessingUnit, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AutoMlSortBy
When writing a match expression against AutoMlSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AutoMlSortOrder
When writing a match expression against AutoMlSortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AutoMls3DataType
When writing a match expression against AutoMls3DataType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AutoMountHomeEfs
When writing a match expression against AutoMountHomeEfs, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AutotuneMode
When writing a match expression against AutotuneMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AwsManagedHumanLoopRequestSource
When writing a match expression against AwsManagedHumanLoopRequestSource, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
BatchDeleteClusterNodesErrorCode
When writing a match expression against BatchDeleteClusterNodesErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
BatchStrategy
When writing a match expression against BatchStrategy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
BooleanOperator
When writing a match expression against BooleanOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CandidateSortBy
When writing a match expression against CandidateSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CandidateStatus
When writing a match expression against CandidateStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CandidateStepType
When writing a match expression against CandidateStepType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CapacityReservationPreference
When writing a match expression against CapacityReservationPreference, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CapacitySizeType
When writing a match expression against CapacitySizeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CaptureMode
When writing a match expression against CaptureMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CaptureStatus
When writing a match expression against CaptureStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ClarifyFeatureType
When writing a match expression against ClarifyFeatureType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ClarifyTextGranularity
When writing a match expression against ClarifyTextGranularity, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ClarifyTextLanguage
When writing a match expression against ClarifyTextLanguage, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ClusterInstanceStatus
When writing a match expression against ClusterInstanceStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ClusterInstanceStorageConfig

Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.

ClusterInstanceType
When writing a match expression against ClusterInstanceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ClusterNodeRecovery
When writing a match expression against ClusterNodeRecovery, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ClusterSortBy
When writing a match expression against ClusterSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ClusterStatus
When writing a match expression against ClusterStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CodeRepositorySortBy
When writing a match expression against CodeRepositorySortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CodeRepositorySortOrder
When writing a match expression against CodeRepositorySortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CollectionConfig

Configuration for your collection.

CollectionType
When writing a match expression against CollectionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CompilationJobStatus
When writing a match expression against CompilationJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CompleteOnConvergence
When writing a match expression against CompleteOnConvergence, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CompressionType
When writing a match expression against CompressionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ConditionOutcome
When writing a match expression against ConditionOutcome, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ContainerMode
When writing a match expression against ContainerMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ContentClassifier
When writing a match expression against ContentClassifier, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CrossAccountFilterOption
When writing a match expression against CrossAccountFilterOption, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CustomFileSystem

A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

CustomFileSystemConfig

The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

DataDistributionType
When writing a match expression against DataDistributionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DataSourceName
When writing a match expression against DataSourceName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DeepHealthCheckType
When writing a match expression against DeepHealthCheckType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DetailedAlgorithmStatus
When writing a match expression against DetailedAlgorithmStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DetailedModelPackageStatus
When writing a match expression against DetailedModelPackageStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DeviceDeploymentStatus
When writing a match expression against DeviceDeploymentStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DeviceSubsetType
When writing a match expression against DeviceSubsetType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DirectInternetAccess
When writing a match expression against DirectInternetAccess, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
Direction
When writing a match expression against Direction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DomainStatus
When writing a match expression against DomainStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EdgePackagingJobStatus
When writing a match expression against EdgePackagingJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EdgePresetDeploymentStatus
When writing a match expression against EdgePresetDeploymentStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EdgePresetDeploymentType
When writing a match expression against EdgePresetDeploymentType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EnabledOrDisabled
When writing a match expression against EnabledOrDisabled, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EndpointConfigSortKey
When writing a match expression against EndpointConfigSortKey, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EndpointSortKey
When writing a match expression against EndpointSortKey, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EndpointStatus
When writing a match expression against EndpointStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ExecutionRoleIdentityConfig
When writing a match expression against ExecutionRoleIdentityConfig, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ExecutionStatus
When writing a match expression against ExecutionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
FailureHandlingPolicy
When writing a match expression against FailureHandlingPolicy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
FairShare
When writing a match expression against FairShare, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
FeatureGroupSortBy
When writing a match expression against FeatureGroupSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
FeatureGroupSortOrder
When writing a match expression against FeatureGroupSortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
FeatureGroupStatus
When writing a match expression against FeatureGroupStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
FeatureStatus
When writing a match expression against FeatureStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
FeatureType
When writing a match expression against FeatureType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
FileSystemAccessMode
When writing a match expression against FileSystemAccessMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
FileSystemType
When writing a match expression against FileSystemType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
FillingType
When writing a match expression against FillingType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
FlatInvocations
When writing a match expression against FlatInvocations, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
FlowDefinitionStatus
When writing a match expression against FlowDefinitionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
Framework
When writing a match expression against Framework, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
HubContentSortBy
When writing a match expression against HubContentSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
HubContentStatus
When writing a match expression against HubContentStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
HubContentSupportStatus
When writing a match expression against HubContentSupportStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
HubContentType
When writing a match expression against HubContentType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
HubSortBy
When writing a match expression against HubSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
HubStatus
When writing a match expression against HubStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
HumanTaskUiStatus
When writing a match expression against HumanTaskUiStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
HyperParameterScalingType
When writing a match expression against HyperParameterScalingType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
HyperParameterTuningAllocationStrategy
When writing a match expression against HyperParameterTuningAllocationStrategy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
HyperParameterTuningJobObjectiveType
When writing a match expression against HyperParameterTuningJobObjectiveType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
HyperParameterTuningJobSortByOptions
When writing a match expression against HyperParameterTuningJobSortByOptions, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
HyperParameterTuningJobStatus
When writing a match expression against HyperParameterTuningJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
HyperParameterTuningJobStrategyType
When writing a match expression against HyperParameterTuningJobStrategyType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
HyperParameterTuningJobWarmStartType
When writing a match expression against HyperParameterTuningJobWarmStartType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ImageSortBy
When writing a match expression against ImageSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ImageSortOrder
When writing a match expression against ImageSortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ImageStatus
When writing a match expression against ImageStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ImageVersionSortBy
When writing a match expression against ImageVersionSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ImageVersionSortOrder
When writing a match expression against ImageVersionSortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ImageVersionStatus
When writing a match expression against ImageVersionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
InferenceComponentCapacitySizeType
When writing a match expression against InferenceComponentCapacitySizeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
InferenceComponentSortKey
When writing a match expression against InferenceComponentSortKey, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
InferenceComponentStatus
When writing a match expression against InferenceComponentStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
InferenceExecutionMode
When writing a match expression against InferenceExecutionMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
InferenceExperimentStatus
When writing a match expression against InferenceExperimentStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
InferenceExperimentStopDesiredState
When writing a match expression against InferenceExperimentStopDesiredState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
InferenceExperimentType
When writing a match expression against InferenceExperimentType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
InputMode
When writing a match expression against InputMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
InstanceGroupStatus
When writing a match expression against InstanceGroupStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
InstanceType
When writing a match expression against InstanceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
IsTrackingServerActive
When writing a match expression against IsTrackingServerActive, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
JobType
When writing a match expression against JobType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
JoinSource
When writing a match expression against JoinSource, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
LabelingJobStatus
When writing a match expression against LabelingJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
LastUpdateStatusValue
When writing a match expression against LastUpdateStatusValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
LifecycleManagement
When writing a match expression against LifecycleManagement, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
LineageType
When writing a match expression against LineageType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ListCompilationJobsSortBy
When writing a match expression against ListCompilationJobsSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ListDeviceFleetsSortBy
When writing a match expression against ListDeviceFleetsSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ListEdgeDeploymentPlansSortBy
When writing a match expression against ListEdgeDeploymentPlansSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ListEdgePackagingJobsSortBy
When writing a match expression against ListEdgePackagingJobsSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ListInferenceRecommendationsJobsSortBy
When writing a match expression against ListInferenceRecommendationsJobsSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ListLabelingJobsForWorkteamSortByOptions
When writing a match expression against ListLabelingJobsForWorkteamSortByOptions, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ListOptimizationJobsSortBy
When writing a match expression against ListOptimizationJobsSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ListWorkforcesSortByOptions
When writing a match expression against ListWorkforcesSortByOptions, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ListWorkteamsSortByOptions
When writing a match expression against ListWorkteamsSortByOptions, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ManagedInstanceScalingStatus
When writing a match expression against ManagedInstanceScalingStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
MetricSetSource
When writing a match expression against MetricSetSource, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
MetricSpecification

An object containing information about a metric.

MlTools
When writing a match expression against MlTools, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelApprovalStatus
When writing a match expression against ModelApprovalStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelCacheSetting
When writing a match expression against ModelCacheSetting, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelCardExportJobSortBy
When writing a match expression against ModelCardExportJobSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelCardExportJobSortOrder
When writing a match expression against ModelCardExportJobSortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelCardExportJobStatus
When writing a match expression against ModelCardExportJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelCardProcessingStatus
When writing a match expression against ModelCardProcessingStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelCardSortBy
When writing a match expression against ModelCardSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelCardSortOrder
When writing a match expression against ModelCardSortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelCardStatus
When writing a match expression against ModelCardStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelCardVersionSortBy
When writing a match expression against ModelCardVersionSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelCompressionType
When writing a match expression against ModelCompressionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelInfrastructureType
When writing a match expression against ModelInfrastructureType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelMetadataFilterType
When writing a match expression against ModelMetadataFilterType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelPackageGroupSortBy
When writing a match expression against ModelPackageGroupSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelPackageGroupStatus
When writing a match expression against ModelPackageGroupStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelPackageSortBy
When writing a match expression against ModelPackageSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelPackageStatus
When writing a match expression against ModelPackageStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelPackageType
When writing a match expression against ModelPackageType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelSortKey
When writing a match expression against ModelSortKey, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelVariantAction
When writing a match expression against ModelVariantAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ModelVariantStatus
When writing a match expression against ModelVariantStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
MonitoringAlertHistorySortKey
When writing a match expression against MonitoringAlertHistorySortKey, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
MonitoringAlertStatus
When writing a match expression against MonitoringAlertStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
MonitoringExecutionSortKey
When writing a match expression against MonitoringExecutionSortKey, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
MonitoringJobDefinitionSortKey
When writing a match expression against MonitoringJobDefinitionSortKey, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
MonitoringProblemType
When writing a match expression against MonitoringProblemType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
MonitoringScheduleSortKey
When writing a match expression against MonitoringScheduleSortKey, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
MonitoringType
When writing a match expression against MonitoringType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
NodeUnavailabilityType
When writing a match expression against NodeUnavailabilityType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
NotebookInstanceAcceleratorType
When writing a match expression against NotebookInstanceAcceleratorType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
NotebookInstanceLifecycleConfigSortKey
When writing a match expression against NotebookInstanceLifecycleConfigSortKey, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
NotebookInstanceLifecycleConfigSortOrder
When writing a match expression against NotebookInstanceLifecycleConfigSortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
NotebookInstanceSortKey
When writing a match expression against NotebookInstanceSortKey, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
NotebookInstanceSortOrder
When writing a match expression against NotebookInstanceSortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
NotebookInstanceStatus
When writing a match expression against NotebookInstanceStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
NotebookOutputOption
When writing a match expression against NotebookOutputOption, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ObjectiveStatus
When writing a match expression against ObjectiveStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
OfflineStoreStatusValue
When writing a match expression against OfflineStoreStatusValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
Operator
When writing a match expression against Operator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
OptimizationConfig

Settings for an optimization technique that you apply with a model optimization job.

OptimizationJobDeploymentInstanceType
When writing a match expression against OptimizationJobDeploymentInstanceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
OptimizationJobStatus
When writing a match expression against OptimizationJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
OrderKey
When writing a match expression against OrderKey, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
OutputCompressionType
When writing a match expression against OutputCompressionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ParameterType
When writing a match expression against ParameterType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PartnerAppAuthType
When writing a match expression against PartnerAppAuthType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PartnerAppStatus
When writing a match expression against PartnerAppStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PartnerAppType
When writing a match expression against PartnerAppType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PipelineExecutionStatus
When writing a match expression against PipelineExecutionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PipelineStatus
When writing a match expression against PipelineStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PreemptTeamTasks
When writing a match expression against PreemptTeamTasks, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ProblemType
When writing a match expression against ProblemType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ProcessingInstanceType
When writing a match expression against ProcessingInstanceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ProcessingJobStatus
When writing a match expression against ProcessingJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ProcessingS3CompressionType
When writing a match expression against ProcessingS3CompressionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ProcessingS3DataDistributionType
When writing a match expression against ProcessingS3DataDistributionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ProcessingS3DataType
When writing a match expression against ProcessingS3DataType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ProcessingS3InputMode
When writing a match expression against ProcessingS3InputMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ProcessingS3UploadMode
When writing a match expression against ProcessingS3UploadMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
Processor
When writing a match expression against Processor, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ProductionVariantAcceleratorType
When writing a match expression against ProductionVariantAcceleratorType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ProductionVariantInferenceAmiVersion
When writing a match expression against ProductionVariantInferenceAmiVersion, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ProductionVariantInstanceType
When writing a match expression against ProductionVariantInstanceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ProfilingStatus
When writing a match expression against ProfilingStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ProjectSortBy
When writing a match expression against ProjectSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ProjectSortOrder
When writing a match expression against ProjectSortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ProjectStatus
When writing a match expression against ProjectStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RStudioServerProAccessStatus
When writing a match expression against RStudioServerProAccessStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RStudioServerProUserGroup
When writing a match expression against RStudioServerProUserGroup, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RecommendationJobStatus
When writing a match expression against RecommendationJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RecommendationJobSupportedEndpointType
When writing a match expression against RecommendationJobSupportedEndpointType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RecommendationJobType
When writing a match expression against RecommendationJobType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RecommendationStatus
When writing a match expression against RecommendationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RecommendationStepType
When writing a match expression against RecommendationStepType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RecordWrapper
When writing a match expression against RecordWrapper, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RedshiftResultCompressionType
When writing a match expression against RedshiftResultCompressionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RedshiftResultFormat
When writing a match expression against RedshiftResultFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
Relation
When writing a match expression against Relation, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RepositoryAccessMode
When writing a match expression against RepositoryAccessMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ReservedCapacityInstanceType
When writing a match expression against ReservedCapacityInstanceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ReservedCapacityStatus
When writing a match expression against ReservedCapacityStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ResourceCatalogSortBy
When writing a match expression against ResourceCatalogSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ResourceCatalogSortOrder
When writing a match expression against ResourceCatalogSortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ResourceSharingStrategy
When writing a match expression against ResourceSharingStrategy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ResourceType
When writing a match expression against ResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RetentionType
When writing a match expression against RetentionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RootAccess
When writing a match expression against RootAccess, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RoutingStrategy
When writing a match expression against RoutingStrategy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RuleEvaluationStatus
When writing a match expression against RuleEvaluationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
S3DataDistribution
When writing a match expression against S3DataDistribution, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
S3DataType
When writing a match expression against S3DataType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
S3ModelDataType
When writing a match expression against S3ModelDataType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SageMakerImageName
When writing a match expression against SageMakerImageName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SageMakerResourceName
When writing a match expression against SageMakerResourceName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SagemakerServicecatalogStatus
When writing a match expression against SagemakerServicecatalogStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ScalingPolicy

An object containing a recommended scaling policy.

ScheduleStatus
When writing a match expression against ScheduleStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SchedulerResourceStatus
When writing a match expression against SchedulerResourceStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SearchSortOrder
When writing a match expression against SearchSortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SecondaryStatus
When writing a match expression against SecondaryStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SharingType
When writing a match expression against SharingType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SkipModelValidation
When writing a match expression against SkipModelValidation, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortActionsBy
When writing a match expression against SortActionsBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortArtifactsBy
When writing a match expression against SortArtifactsBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortAssociationsBy
When writing a match expression against SortAssociationsBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortBy
When writing a match expression against SortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortClusterSchedulerConfigBy
When writing a match expression against SortClusterSchedulerConfigBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortContextsBy
When writing a match expression against SortContextsBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortExperimentsBy
When writing a match expression against SortExperimentsBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortInferenceExperimentsBy
When writing a match expression against SortInferenceExperimentsBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortLineageGroupsBy
When writing a match expression against SortLineageGroupsBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortOrder
When writing a match expression against SortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortPipelineExecutionsBy
When writing a match expression against SortPipelineExecutionsBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortPipelinesBy
When writing a match expression against SortPipelinesBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortQuotaBy
When writing a match expression against SortQuotaBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortTrackingServerBy
When writing a match expression against SortTrackingServerBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortTrialComponentsBy
When writing a match expression against SortTrialComponentsBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SortTrialsBy
When writing a match expression against SortTrialsBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SpaceSortKey
When writing a match expression against SpaceSortKey, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SpaceStatus
When writing a match expression against SpaceStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SplitType
When writing a match expression against SplitType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
StageStatus
When writing a match expression against StageStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
Statistic
When writing a match expression against Statistic, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
StepStatus
When writing a match expression against StepStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
StorageType
When writing a match expression against StorageType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
StudioLifecycleConfigAppType
When writing a match expression against StudioLifecycleConfigAppType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
StudioLifecycleConfigSortKey
When writing a match expression against StudioLifecycleConfigSortKey, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
StudioWebPortal
When writing a match expression against StudioWebPortal, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TableFormat
When writing a match expression against TableFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TagPropagation
When writing a match expression against TagPropagation, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TargetDevice
When writing a match expression against TargetDevice, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TargetPlatformAccelerator
When writing a match expression against TargetPlatformAccelerator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TargetPlatformArch
When writing a match expression against TargetPlatformArch, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TargetPlatformOs
When writing a match expression against TargetPlatformOs, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ThroughputMode
When writing a match expression against ThroughputMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TrackingServerMaintenanceStatus
When writing a match expression against TrackingServerMaintenanceStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TrackingServerSize
When writing a match expression against TrackingServerSize, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TrackingServerStatus
When writing a match expression against TrackingServerStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TrafficRoutingConfigType
When writing a match expression against TrafficRoutingConfigType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TrafficType
When writing a match expression against TrafficType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TrainingInputMode
When writing a match expression against TrainingInputMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TrainingInstanceType
When writing a match expression against TrainingInstanceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TrainingJobEarlyStoppingType
When writing a match expression against TrainingJobEarlyStoppingType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TrainingJobSortByOptions
When writing a match expression against TrainingJobSortByOptions, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TrainingJobStatus
When writing a match expression against TrainingJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TrainingPlanFilterName
When writing a match expression against TrainingPlanFilterName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TrainingPlanSortBy
When writing a match expression against TrainingPlanSortBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TrainingPlanSortOrder
When writing a match expression against TrainingPlanSortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TrainingPlanStatus
When writing a match expression against TrainingPlanStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TrainingRepositoryAccessMode
When writing a match expression against TrainingRepositoryAccessMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TransformInstanceType
When writing a match expression against TransformInstanceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TransformJobStatus
When writing a match expression against TransformJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TrialComponentParameterValue

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

This object is specified in the CreateTrialComponent request.

TrialComponentPrimaryStatus
When writing a match expression against TrialComponentPrimaryStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TtlDurationUnit
When writing a match expression against TtlDurationUnit, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
UserProfileSortKey
When writing a match expression against UserProfileSortKey, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
UserProfileStatus
When writing a match expression against UserProfileStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
VariantPropertyType
When writing a match expression against VariantPropertyType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
VariantStatus
When writing a match expression against VariantStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
VendorGuidance
When writing a match expression against VendorGuidance, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
WarmPoolResourceStatus
When writing a match expression against WarmPoolResourceStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
WorkforceStatus
When writing a match expression against WorkforceStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.