1. Packages
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. sagemaker
  6. TrialComponent

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.74.1
published on Monday, Aug 3, 2026 by Pulumi
aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.74.1
published on Monday, Aug 3, 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:

    DisplayName string
    The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
    InputArtifacts Dictionary<string, Pulumi.AwsNative.SageMaker.Inputs.TrialComponentArtifactArgs>
    The input artifacts for the component.
    MetadataProperties Pulumi.AwsNative.SageMaker.Inputs.TrialComponentMetadataProperties
    OutputArtifacts Dictionary<string, Pulumi.AwsNative.SageMaker.Inputs.TrialComponentArtifactArgs>
    The output artifacts for the component.
    Parameters Dictionary<string, Pulumi.AwsNative.SageMaker.Inputs.TrialComponentParameterValueArgs>
    The hyperparameters for the component.
    Status Pulumi.AwsNative.SageMaker.Inputs.TrialComponentStatus
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of tags to associate with the trial component.
    TrialComponentName string
    The name of the trial component. Must be unique in your AWS account and is not case-sensitive.
    DisplayName string
    The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
    InputArtifacts map[string]TrialComponentArtifactArgs
    The input artifacts for the component.
    MetadataProperties TrialComponentMetadataPropertiesArgs
    OutputArtifacts map[string]TrialComponentArtifactArgs
    The output artifacts for the component.
    Parameters map[string]TrialComponentParameterValueArgs
    The hyperparameters for the component.
    Status TrialComponentStatusArgs
    Tags TagArgs
    A list of tags to associate with the trial component.
    TrialComponentName string
    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
    tags list(object)
    A list of tags to associate with the trial component.
    trial_component_name string
    The name of the trial component. Must be unique in your AWS account and is not case-sensitive.
    displayName String
    The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
    inputArtifacts Map<String,TrialComponentArtifactArgs>
    The input artifacts for the component.
    metadataProperties TrialComponentMetadataProperties
    outputArtifacts Map<String,TrialComponentArtifactArgs>
    The output artifacts for the component.
    parameters Map<String,TrialComponentParameterValueArgs>
    The hyperparameters for the component.
    status TrialComponentStatus
    tags List<Tag>
    A list of tags to associate with the trial component.
    trialComponentName String
    The name of the trial component. Must be unique in your AWS account and is not case-sensitive.
    displayName string
    The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
    inputArtifacts {[key: string]: TrialComponentArtifactArgs}
    The input artifacts for the component.
    metadataProperties TrialComponentMetadataProperties
    outputArtifacts {[key: string]: TrialComponentArtifactArgs}
    The output artifacts for the component.
    parameters {[key: string]: TrialComponentParameterValueArgs}
    The hyperparameters for the component.
    status TrialComponentStatus
    tags Tag[]
    A list of tags to associate with the trial component.
    trialComponentName string
    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, TrialComponentArtifactArgs]
    The input artifacts for the component.
    metadata_properties TrialComponentMetadataPropertiesArgs
    output_artifacts Mapping[str, TrialComponentArtifactArgs]
    The output artifacts for the component.
    parameters Mapping[str, TrialComponentParameterValueArgs]
    The hyperparameters for the component.
    status TrialComponentStatusArgs
    tags Sequence[TagArgs]
    A list of tags to associate with the trial component.
    trial_component_name str
    The name of the trial component. Must be unique in your AWS account and is not case-sensitive.
    displayName String
    The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
    inputArtifacts Map<Property Map>
    The input artifacts for the component.
    metadataProperties Property Map
    outputArtifacts Map<Property Map>
    The output artifacts for the component.
    parameters Map<Property Map>
    The hyperparameters for the component.
    status Property Map
    tags List<Property Map>
    A list of tags to associate with the trial component.
    trialComponentName String
    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:

    CreationTime string
    When the trial component was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    When the trial component was last modified.
    LineageGroupArn string
    The Amazon Resource Name (ARN) of the lineage group.
    TrialComponentArn string
    The Amazon Resource Name (ARN) of the trial component.
    CreationTime string
    When the trial component was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    When the trial component was last modified.
    LineageGroupArn string
    The Amazon Resource Name (ARN) of the lineage group.
    TrialComponentArn string
    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_time string
    When the trial component was last modified.
    lineage_group_arn string
    The Amazon Resource Name (ARN) of the lineage group.
    trial_component_arn string
    The Amazon Resource Name (ARN) of the trial component.
    creationTime String
    When the trial component was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime String
    When the trial component was last modified.
    lineageGroupArn String
    The Amazon Resource Name (ARN) of the lineage group.
    trialComponentArn String
    The Amazon Resource Name (ARN) of the trial component.
    creationTime string
    When the trial component was created.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime string
    When the trial component was last modified.
    lineageGroupArn string
    The Amazon Resource Name (ARN) of the lineage group.
    trialComponentArn string
    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_time str
    When the trial component was last modified.
    lineage_group_arn str
    The Amazon Resource Name (ARN) of the lineage group.
    trial_component_arn str
    The Amazon Resource Name (ARN) of the trial component.
    creationTime String
    When the trial component was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime String
    When the trial component was last modified.
    lineageGroupArn String
    The Amazon Resource Name (ARN) of the lineage group.
    trialComponentArn String
    The Amazon Resource Name (ARN) of the trial component.

    Supporting Types

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    TrialComponentArtifact, TrialComponentArtifactArgs

    Represents an input or output artifact of a trial component.
    Value string
    The location of the artifact.
    MediaType string
    The media type of the artifact.
    Value string
    The location of the artifact.
    MediaType string
    The media type of the artifact.
    value string
    The location of the artifact.
    media_type string
    The media type of the artifact.
    value String
    The location of the artifact.
    mediaType String
    The media type of the artifact.
    value string
    The location of the artifact.
    mediaType string
    The media type of the artifact.
    value str
    The location of the artifact.
    media_type str
    The media type of the artifact.
    value String
    The location of the artifact.
    mediaType String
    The media type of the artifact.

    TrialComponentMetadataProperties, TrialComponentMetadataPropertiesArgs

    Metadata properties of the tracking entity, trial, or trial component.
    CommitId string
    The commit ID.
    GeneratedBy string
    The entity this entity was generated by.
    ProjectId string
    The project ID.
    Repository string
    The repository.
    CommitId string
    The commit ID.
    GeneratedBy string
    The entity this entity was generated by.
    ProjectId 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.
    commitId String
    The commit ID.
    generatedBy String
    The entity this entity was generated by.
    projectId String
    The project ID.
    repository String
    The repository.
    commitId string
    The commit ID.
    generatedBy string
    The entity this entity was generated by.
    projectId 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.
    commitId String
    The commit ID.
    generatedBy String
    The entity this entity was generated by.
    projectId String
    The project ID.
    repository String
    The repository.

    TrialComponentParameterValue, TrialComponentParameterValueArgs

    The value of a hyperparameter. Only one of StringValue or NumberValue can be specified.
    NumberValue double
    The numeric value of a numeric hyperparameter.
    StringValue string
    The string value of a categorical hyperparameter.
    NumberValue float64
    The numeric value of a numeric hyperparameter.
    StringValue 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.
    numberValue Double
    The numeric value of a numeric hyperparameter.
    stringValue String
    The string value of a categorical hyperparameter.
    numberValue number
    The numeric value of a numeric hyperparameter.
    stringValue 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.
    numberValue Number
    The numeric value of a numeric hyperparameter.
    stringValue 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.
    PrimaryStatus Pulumi.AwsNative.SageMaker.TrialComponentStatusPrimaryStatus
    The status of the trial component.
    Message string
    If the component failed, a message describing why.
    PrimaryStatus TrialComponentStatusPrimaryStatus
    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.
    primaryStatus TrialComponentStatusPrimaryStatus
    The status of the trial component.
    message string
    If the component failed, a message describing why.
    primaryStatus TrialComponentStatusPrimaryStatus
    The status of the trial component.
    message str
    If the component failed, a message describing why.
    primary_status TrialComponentStatusPrimaryStatus
    The status of the trial component.
    message String
    If the component failed, a message describing why.
    primaryStatus "InProgress" | "Completed" | "Failed" | "Stopping" | "Stopped"
    The status of the trial component.

    TrialComponentStatusPrimaryStatus, TrialComponentStatusPrimaryStatusArgs

    InProgress
    InProgress
    Completed
    Completed
    Failed
    Failed
    Stopping
    Stopping
    Stopped
    Stopped
    TrialComponentStatusPrimaryStatusInProgress
    InProgress
    TrialComponentStatusPrimaryStatusCompleted
    Completed
    TrialComponentStatusPrimaryStatusFailed
    Failed
    TrialComponentStatusPrimaryStatusStopping
    Stopping
    TrialComponentStatusPrimaryStatusStopped
    Stopped
    "InProgress"
    InProgress
    "Completed"
    Completed
    "Failed"
    Failed
    "Stopping"
    Stopping
    "Stopped"
    Stopped
    InProgress
    InProgress
    Completed
    Completed
    Failed
    Failed
    Stopping
    Stopping
    Stopped
    Stopped
    InProgress
    InProgress
    Completed
    Completed
    Failed
    Failed
    Stopping
    Stopping
    Stopped
    Stopped
    IN_PROGRESS
    InProgress
    COMPLETED
    Completed
    FAILED
    Failed
    STOPPING
    Stopping
    STOPPED
    Stopped
    "InProgress"
    InProgress
    "Completed"
    Completed
    "Failed"
    Failed
    "Stopping"
    Stopping
    "Stopped"
    Stopped

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.74.1
    published on Monday, Aug 3, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial