1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_trial_component::_create_trial_component_output::CreateTrialComponentOutputBuilder;
pub use crate::operation::create_trial_component::_create_trial_component_input::CreateTrialComponentInputBuilder;
impl CreateTrialComponentInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::create_trial_component::CreateTrialComponentOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::create_trial_component::CreateTrialComponentError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.create_trial_component();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `CreateTrialComponent`.
///
/// <p>Creates a <i>trial component</i>, which is a stage of a machine learning <i>trial</i>. A trial is composed of one or more trial components. A trial component can be used in multiple trials.</p>
/// <p>Trial components include pre-processing jobs, training jobs, and batch transform jobs.</p>
/// <p>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.</p>
/// <p>You can add tags to a trial component and then use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search for the tags.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct CreateTrialComponentFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::create_trial_component::builders::CreateTrialComponentInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::create_trial_component::CreateTrialComponentOutput,
crate::operation::create_trial_component::CreateTrialComponentError,
> for CreateTrialComponentFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::create_trial_component::CreateTrialComponentOutput,
crate::operation::create_trial_component::CreateTrialComponentError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl CreateTrialComponentFluentBuilder {
/// Creates a new `CreateTrialComponent`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the CreateTrialComponent as a reference.
pub fn as_input(&self) -> &crate::operation::create_trial_component::builders::CreateTrialComponentInputBuilder {
&self.inner
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::create_trial_component::CreateTrialComponentOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::create_trial_component::CreateTrialComponentError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::create_trial_component::CreateTrialComponent::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::create_trial_component::CreateTrialComponent::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::create_trial_component::CreateTrialComponentOutput,
crate::operation::create_trial_component::CreateTrialComponentError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl Into<crate::config::Builder>) -> Self {
self.set_config_override(Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.</p>
pub fn trial_component_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.trial_component_name(input.into());
self
}
/// <p>The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.</p>
pub fn set_trial_component_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_trial_component_name(input);
self
}
/// <p>The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.</p>
pub fn get_trial_component_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_trial_component_name()
}
/// <p>The name of the component as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>TrialComponentName</code> is displayed.</p>
pub fn display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.display_name(input.into());
self
}
/// <p>The name of the component as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>TrialComponentName</code> is displayed.</p>
pub fn set_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_display_name(input);
self
}
/// <p>The name of the component as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>TrialComponentName</code> is displayed.</p>
pub fn get_display_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_display_name()
}
/// <p>The status of the component. States include:</p>
/// <ul>
/// <li> <p>InProgress</p> </li>
/// <li> <p>Completed</p> </li>
/// <li> <p>Failed</p> </li>
/// </ul>
pub fn status(mut self, input: crate::types::TrialComponentStatus) -> Self {
self.inner = self.inner.status(input);
self
}
/// <p>The status of the component. States include:</p>
/// <ul>
/// <li> <p>InProgress</p> </li>
/// <li> <p>Completed</p> </li>
/// <li> <p>Failed</p> </li>
/// </ul>
pub fn set_status(mut self, input: ::std::option::Option<crate::types::TrialComponentStatus>) -> Self {
self.inner = self.inner.set_status(input);
self
}
/// <p>The status of the component. States include:</p>
/// <ul>
/// <li> <p>InProgress</p> </li>
/// <li> <p>Completed</p> </li>
/// <li> <p>Failed</p> </li>
/// </ul>
pub fn get_status(&self) -> &::std::option::Option<crate::types::TrialComponentStatus> {
self.inner.get_status()
}
/// <p>When the component started.</p>
pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.inner = self.inner.start_time(input);
self
}
/// <p>When the component started.</p>
pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.inner = self.inner.set_start_time(input);
self
}
/// <p>When the component started.</p>
pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
self.inner.get_start_time()
}
/// <p>When the component ended.</p>
pub fn end_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.inner = self.inner.end_time(input);
self
}
/// <p>When the component ended.</p>
pub fn set_end_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.inner = self.inner.set_end_time(input);
self
}
/// <p>When the component ended.</p>
pub fn get_end_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
self.inner.get_end_time()
}
/// Adds a key-value pair to `Parameters`.
///
/// To override the contents of this collection use [`set_parameters`](Self::set_parameters).
///
/// <p>The hyperparameters for the component.</p>
pub fn parameters(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::TrialComponentParameterValue) -> Self {
self.inner = self.inner.parameters(k.into(), v);
self
}
/// <p>The hyperparameters for the component.</p>
pub fn set_parameters(
mut self,
input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::TrialComponentParameterValue>>,
) -> Self {
self.inner = self.inner.set_parameters(input);
self
}
/// <p>The hyperparameters for the component.</p>
pub fn get_parameters(
&self,
) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::TrialComponentParameterValue>> {
self.inner.get_parameters()
}
/// Adds a key-value pair to `InputArtifacts`.
///
/// To override the contents of this collection use [`set_input_artifacts`](Self::set_input_artifacts).
///
/// <p>The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.</p>
pub fn input_artifacts(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::TrialComponentArtifact) -> Self {
self.inner = self.inner.input_artifacts(k.into(), v);
self
}
/// <p>The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.</p>
pub fn set_input_artifacts(
mut self,
input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::TrialComponentArtifact>>,
) -> Self {
self.inner = self.inner.set_input_artifacts(input);
self
}
/// <p>The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.</p>
pub fn get_input_artifacts(
&self,
) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::TrialComponentArtifact>> {
self.inner.get_input_artifacts()
}
/// Adds a key-value pair to `OutputArtifacts`.
///
/// To override the contents of this collection use [`set_output_artifacts`](Self::set_output_artifacts).
///
/// <p>The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.</p>
pub fn output_artifacts(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::TrialComponentArtifact) -> Self {
self.inner = self.inner.output_artifacts(k.into(), v);
self
}
/// <p>The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.</p>
pub fn set_output_artifacts(
mut self,
input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::TrialComponentArtifact>>,
) -> Self {
self.inner = self.inner.set_output_artifacts(input);
self
}
/// <p>The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.</p>
pub fn get_output_artifacts(
&self,
) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::TrialComponentArtifact>> {
self.inner.get_output_artifacts()
}
/// <p>Metadata properties of the tracking entity, trial, or trial component.</p>
pub fn metadata_properties(mut self, input: crate::types::MetadataProperties) -> Self {
self.inner = self.inner.metadata_properties(input);
self
}
/// <p>Metadata properties of the tracking entity, trial, or trial component.</p>
pub fn set_metadata_properties(mut self, input: ::std::option::Option<crate::types::MetadataProperties>) -> Self {
self.inner = self.inner.set_metadata_properties(input);
self
}
/// <p>Metadata properties of the tracking entity, trial, or trial component.</p>
pub fn get_metadata_properties(&self) -> &::std::option::Option<crate::types::MetadataProperties> {
self.inner.get_metadata_properties()
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>A list of tags to associate with the component. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search on the tags.</p>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>A list of tags to associate with the component. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search on the tags.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.inner = self.inner.set_tags(input);
self
}
/// <p>A list of tags to associate with the component. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search on the tags.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
self.inner.get_tags()
}
}