Struct aws_sdk_sagemaker::client::fluent_builders::CreateTrial

pub struct CreateTrial<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreateTrial.

Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial and then use the Search API to search for the tags.

To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.

Implementations

impl<C, M, R> CreateTrial<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<CreateTrialOutput, SdkError<CreateTrialError>> where
    R::Policy: SmithyRetryPolicy<CreateTrialInputOperationOutputAlias, CreateTrialOutput, CreateTrialError, CreateTrialInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn trial_name(self, inp: impl Into<String>) -> Self

The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.

pub fn set_trial_name(self, input: Option<String>) -> Self

The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.

pub fn display_name(self, inp: impl Into<String>) -> Self

The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.

pub fn set_display_name(self, input: Option<String>) -> Self

The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.

pub fn experiment_name(self, inp: impl Into<String>) -> Self

The name of the experiment to associate the trial with.

pub fn set_experiment_name(self, input: Option<String>) -> Self

The name of the experiment to associate the trial with.

pub fn metadata_properties(self, inp: MetadataProperties) -> Self

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

pub fn set_metadata_properties(self, input: Option<MetadataProperties>) -> Self

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

pub fn tags(self, inp: impl Into<Tag>) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

A list of tags to associate with the trial. You can use Search API to search on the tags.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

A list of tags to associate with the trial. You can use Search API to search on the tags.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for CreateTrial<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.