We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 17, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 17, 2026 by Pulumi
Resource type definition for AWS::SageMaker::TrialComponent. A trial component is a stage of a machine learning trial, such as a preprocessing job, training job, or batch transform job.
Create TrialComponent Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TrialComponent(name: string, args?: TrialComponentArgs, opts?: CustomResourceOptions);@overload
def TrialComponent(resource_name: str,
args: Optional[TrialComponentArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def TrialComponent(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
input_artifacts: Optional[Mapping[str, TrialComponentArtifactArgs]] = None,
metadata_properties: Optional[TrialComponentMetadataPropertiesArgs] = None,
output_artifacts: Optional[Mapping[str, TrialComponentArtifactArgs]] = None,
parameters: Optional[Mapping[str, TrialComponentParameterValueArgs]] = None,
status: Optional[TrialComponentStatusArgs] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
trial_component_name: Optional[str] = None)func NewTrialComponent(ctx *Context, name string, args *TrialComponentArgs, opts ...ResourceOption) (*TrialComponent, error)public TrialComponent(string name, TrialComponentArgs? args = null, CustomResourceOptions? opts = null)
public TrialComponent(String name, TrialComponentArgs args)
public TrialComponent(String name, TrialComponentArgs args, CustomResourceOptions options)
type: aws-native:sagemaker:TrialComponent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_sagemaker_trial_component" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args TrialComponentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args TrialComponentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TrialComponentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TrialComponentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TrialComponentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
TrialComponent Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The TrialComponent resource accepts the following input properties:
- Display
Name string - The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
- Input
Artifacts Dictionary<string, Pulumi.Aws Native. Sage Maker. Inputs. Trial Component Artifact Args> - The input artifacts for the component.
- Metadata
Properties Pulumi.Aws Native. Sage Maker. Inputs. Trial Component Metadata Properties - Output
Artifacts Dictionary<string, Pulumi.Aws Native. Sage Maker. Inputs. Trial Component Artifact Args> - The output artifacts for the component.
- Parameters
Dictionary<string, Pulumi.
Aws Native. Sage Maker. Inputs. Trial Component Parameter Value Args> - The hyperparameters for the component.
- Status
Pulumi.
Aws Native. Sage Maker. Inputs. Trial Component Status -
List<Pulumi.
Aws Native. Inputs. Tag> - A list of tags to associate with the trial component.
- Trial
Component stringName - The name of the trial component. Must be unique in your AWS account and is not case-sensitive.
- Display
Name string - The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
- Input
Artifacts map[string]TrialComponent Artifact Args - The input artifacts for the component.
- Metadata
Properties TrialComponent Metadata Properties Args - Output
Artifacts map[string]TrialComponent Artifact Args - The output artifacts for the component.
- Parameters
map[string]Trial
Component Parameter Value Args - The hyperparameters for the component.
- Status
Trial
Component Status Args -
Tag
Args - A list of tags to associate with the trial component.
- Trial
Component stringName - The name of the trial component. Must be unique in your AWS account and is not case-sensitive.
- display_
name string - The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
- input_
artifacts map(object) - The input artifacts for the component.
- metadata_
properties object - output_
artifacts map(object) - The output artifacts for the component.
- parameters map(object)
- The hyperparameters for the component.
- status object
- list(object)
- A list of tags to associate with the trial component.
- trial_
component_ stringname - The name of the trial component. Must be unique in your AWS account and is not case-sensitive.
- display
Name String - The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
- input
Artifacts Map<String,TrialComponent Artifact Args> - The input artifacts for the component.
- metadata
Properties TrialComponent Metadata Properties - output
Artifacts Map<String,TrialComponent Artifact Args> - The output artifacts for the component.
- parameters
Map<String,Trial
Component Parameter Value Args> - The hyperparameters for the component.
- status
Trial
Component Status - List<Tag>
- A list of tags to associate with the trial component.
- trial
Component StringName - The name of the trial component. Must be unique in your AWS account and is not case-sensitive.
- display
Name string - The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
- input
Artifacts {[key: string]: TrialComponent Artifact Args} - The input artifacts for the component.
- metadata
Properties TrialComponent Metadata Properties - output
Artifacts {[key: string]: TrialComponent Artifact Args} - The output artifacts for the component.
- parameters
{[key: string]: Trial
Component Parameter Value Args} - The hyperparameters for the component.
- status
Trial
Component Status - Tag[]
- A list of tags to associate with the trial component.
- trial
Component stringName - The name of the trial component. Must be unique in your AWS account and is not case-sensitive.
- display_
name str - The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
- input_
artifacts Mapping[str, TrialComponent Artifact Args] - The input artifacts for the component.
- metadata_
properties TrialComponent Metadata Properties Args - output_
artifacts Mapping[str, TrialComponent Artifact Args] - The output artifacts for the component.
- parameters
Mapping[str, Trial
Component Parameter Value Args] - The hyperparameters for the component.
- status
Trial
Component Status Args -
Sequence[Tag
Args] - A list of tags to associate with the trial component.
- trial_
component_ strname - The name of the trial component. Must be unique in your AWS account and is not case-sensitive.
- display
Name String - The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
- input
Artifacts Map<Property Map> - The input artifacts for the component.
- metadata
Properties Property Map - output
Artifacts Map<Property Map> - The output artifacts for the component.
- parameters Map<Property Map>
- The hyperparameters for the component.
- status Property Map
- List<Property Map>
- A list of tags to associate with the trial component.
- trial
Component StringName - The name of the trial component. Must be unique in your AWS account and is not case-sensitive.
Outputs
All input properties are implicitly available as output properties. Additionally, the TrialComponent resource produces the following output properties:
- Creation
Time string - When the trial component was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringTime - When the trial component was last modified.
- Lineage
Group stringArn - The Amazon Resource Name (ARN) of the lineage group.
- Trial
Component stringArn - The Amazon Resource Name (ARN) of the trial component.
- Creation
Time string - When the trial component was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringTime - When the trial component was last modified.
- Lineage
Group stringArn - The Amazon Resource Name (ARN) of the lineage group.
- Trial
Component stringArn - The Amazon Resource Name (ARN) of the trial component.
- creation_
time string - When the trial component was created.
- id string
- The provider-assigned unique ID for this managed resource.
- last_
modified_ stringtime - When the trial component was last modified.
- lineage_
group_ stringarn - The Amazon Resource Name (ARN) of the lineage group.
- trial_
component_ stringarn - The Amazon Resource Name (ARN) of the trial component.
- creation
Time String - When the trial component was created.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringTime - When the trial component was last modified.
- lineage
Group StringArn - The Amazon Resource Name (ARN) of the lineage group.
- trial
Component StringArn - The Amazon Resource Name (ARN) of the trial component.
- creation
Time string - When the trial component was created.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Modified stringTime - When the trial component was last modified.
- lineage
Group stringArn - The Amazon Resource Name (ARN) of the lineage group.
- trial
Component stringArn - The Amazon Resource Name (ARN) of the trial component.
- creation_
time str - When the trial component was created.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
modified_ strtime - When the trial component was last modified.
- lineage_
group_ strarn - The Amazon Resource Name (ARN) of the lineage group.
- trial_
component_ strarn - The Amazon Resource Name (ARN) of the trial component.
- creation
Time String - When the trial component was created.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringTime - When the trial component was last modified.
- lineage
Group StringArn - The Amazon Resource Name (ARN) of the lineage group.
- trial
Component StringArn - The Amazon Resource Name (ARN) of the trial component.
Supporting Types
Tag, TagArgs
A set of tags to apply to the resource.TrialComponentArtifact, TrialComponentArtifactArgs
Represents an input or output artifact of a trial component.- value string
- The location of the artifact.
- media_
type string - The media type of the artifact.
- value str
- The location of the artifact.
- media_
type str - The media type of the artifact.
TrialComponentMetadataProperties, TrialComponentMetadataPropertiesArgs
Metadata properties of the tracking entity, trial, or trial component.- Commit
Id string - The commit ID.
- Generated
By string - The entity this entity was generated by.
- Project
Id string - The project ID.
- Repository string
- The repository.
- Commit
Id string - The commit ID.
- Generated
By string - The entity this entity was generated by.
- Project
Id string - The project ID.
- Repository string
- The repository.
- commit_
id string - The commit ID.
- generated_
by string - The entity this entity was generated by.
- project_
id string - The project ID.
- repository string
- The repository.
- commit
Id String - The commit ID.
- generated
By String - The entity this entity was generated by.
- project
Id String - The project ID.
- repository String
- The repository.
- commit
Id string - The commit ID.
- generated
By string - The entity this entity was generated by.
- project
Id string - The project ID.
- repository string
- The repository.
- commit_
id str - The commit ID.
- generated_
by str - The entity this entity was generated by.
- project_
id str - The project ID.
- repository str
- The repository.
- commit
Id String - The commit ID.
- generated
By String - The entity this entity was generated by.
- project
Id String - The project ID.
- repository String
- The repository.
TrialComponentParameterValue, TrialComponentParameterValueArgs
The value of a hyperparameter. Only one of StringValue or NumberValue can be specified.- Number
Value double - The numeric value of a numeric hyperparameter.
- String
Value string - The string value of a categorical hyperparameter.
- Number
Value float64 - The numeric value of a numeric hyperparameter.
- String
Value string - The string value of a categorical hyperparameter.
- number_
value number - The numeric value of a numeric hyperparameter.
- string_
value string - The string value of a categorical hyperparameter.
- number
Value Double - The numeric value of a numeric hyperparameter.
- string
Value String - The string value of a categorical hyperparameter.
- number
Value number - The numeric value of a numeric hyperparameter.
- string
Value string - The string value of a categorical hyperparameter.
- number_
value float - The numeric value of a numeric hyperparameter.
- string_
value str - The string value of a categorical hyperparameter.
- number
Value Number - The numeric value of a numeric hyperparameter.
- string
Value String - The string value of a categorical hyperparameter.
TrialComponentStatus, TrialComponentStatusArgs
The status of the trial component.- Message string
- If the component failed, a message describing why.
- Primary
Status Pulumi.Aws Native. Sage Maker. Trial Component Status Primary Status - The status of the trial component.
- Message string
- If the component failed, a message describing why.
- Primary
Status TrialComponent Status Primary Status - The status of the trial component.
- message string
- If the component failed, a message describing why.
- primary_
status "InProgress" | "Completed" | "Failed" | "Stopping" | "Stopped" - The status of the trial component.
- message String
- If the component failed, a message describing why.
- primary
Status TrialComponent Status Primary Status - The status of the trial component.
- message string
- If the component failed, a message describing why.
- primary
Status TrialComponent Status Primary Status - The status of the trial component.
- message str
- If the component failed, a message describing why.
- primary_
status TrialComponent Status Primary Status - The status of the trial component.
- message String
- If the component failed, a message describing why.
- primary
Status "InProgress" | "Completed" | "Failed" | "Stopping" | "Stopped" - The status of the trial component.
TrialComponentStatusPrimaryStatus, TrialComponentStatusPrimaryStatusArgs
- In
Progress InProgress- Completed
Completed- Failed
Failed- Stopping
Stopping- Stopped
Stopped
- Trial
Component Status Primary Status In Progress InProgress- Trial
Component Status Primary Status Completed Completed- Trial
Component Status Primary Status Failed Failed- Trial
Component Status Primary Status Stopping Stopping- Trial
Component Status Primary Status Stopped Stopped
- "In
Progress" InProgress- "Completed"
Completed- "Failed"
Failed- "Stopping"
Stopping- "Stopped"
Stopped
- In
Progress InProgress- Completed
Completed- Failed
Failed- Stopping
Stopping- Stopped
Stopped
- In
Progress InProgress- Completed
Completed- Failed
Failed- Stopping
Stopping- Stopped
Stopped
- IN_PROGRESS
InProgress- COMPLETED
Completed- FAILED
Failed- STOPPING
Stopping- STOPPED
Stopped
- "In
Progress" InProgress- "Completed"
Completed- "Failed"
Failed- "Stopping"
Stopping- "Stopped"
Stopped
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 17, 2026 by Pulumi