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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_compilation_job::_create_compilation_job_output::CreateCompilationJobOutputBuilder;
pub use crate::operation::create_compilation_job::_create_compilation_job_input::CreateCompilationJobInputBuilder;
/// Fluent builder constructing a request to `CreateCompilationJob`.
///
/// <p>Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify. </p>
/// <p>If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.</p>
/// <p>In the request body, you provide the following:</p>
/// <ul>
/// <li> <p>A name for the compilation job</p> </li>
/// <li> <p> Information about the input model artifacts </p> </li>
/// <li> <p>The output location for the compiled model and the device (target) that the model runs on </p> </li>
/// <li> <p>The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job. </p> </li>
/// </ul>
/// <p>You can also provide a <code>Tag</code> to track the model compilation job's resource use and costs. The response body contains the <code>CompilationJobArn</code> for the compiled job.</p>
/// <p>To stop a model compilation job, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopCompilationJob.html">StopCompilationJob</a>. To get information about a particular model compilation job, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeCompilationJob.html">DescribeCompilationJob</a>. To get information about multiple model compilation jobs, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListCompilationJobs.html">ListCompilationJobs</a>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateCompilationJobFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::create_compilation_job::builders::CreateCompilationJobInputBuilder,
}
impl CreateCompilationJobFluentBuilder {
/// Creates a new `CreateCompilationJob`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::create_compilation_job::CreateCompilationJob,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<
crate::operation::create_compilation_job::CreateCompilationJobError,
>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// 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_compilation_job::CreateCompilationJobOutput,
aws_smithy_http::result::SdkError<
crate::operation::create_compilation_job::CreateCompilationJobError,
>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. </p>
pub fn compilation_job_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.compilation_job_name(input.into());
self
}
/// <p>A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. </p>
pub fn set_compilation_job_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_compilation_job_name(input);
self
}
/// <p>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf. </p>
/// <p>During model compilation, Amazon SageMaker needs your permission to:</p>
/// <ul>
/// <li> <p>Read input data from an S3 bucket</p> </li>
/// <li> <p>Write model artifacts to an S3 bucket</p> </li>
/// <li> <p>Write logs to Amazon CloudWatch Logs</p> </li>
/// <li> <p>Publish metrics to Amazon CloudWatch</p> </li>
/// </ul>
/// <p>You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the <code>iam:PassRole</code> permission. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">Amazon SageMaker Roles.</a> </p>
pub fn role_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.role_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf. </p>
/// <p>During model compilation, Amazon SageMaker needs your permission to:</p>
/// <ul>
/// <li> <p>Read input data from an S3 bucket</p> </li>
/// <li> <p>Write model artifacts to an S3 bucket</p> </li>
/// <li> <p>Write logs to Amazon CloudWatch Logs</p> </li>
/// <li> <p>Publish metrics to Amazon CloudWatch</p> </li>
/// </ul>
/// <p>You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the <code>iam:PassRole</code> permission. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">Amazon SageMaker Roles.</a> </p>
pub fn set_role_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_role_arn(input);
self
}
/// <p>The Amazon Resource Name (ARN) of a versioned model package. Provide either a <code>ModelPackageVersionArn</code> or an <code>InputConfig</code> object in the request syntax. The presence of both objects in the <code>CreateCompilationJob</code> request will return an exception.</p>
pub fn model_package_version_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.model_package_version_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of a versioned model package. Provide either a <code>ModelPackageVersionArn</code> or an <code>InputConfig</code> object in the request syntax. The presence of both objects in the <code>CreateCompilationJob</code> request will return an exception.</p>
pub fn set_model_package_version_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_model_package_version_arn(input);
self
}
/// <p>Provides 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.</p>
pub fn input_config(mut self, input: crate::types::InputConfig) -> Self {
self.inner = self.inner.input_config(input);
self
}
/// <p>Provides 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.</p>
pub fn set_input_config(
mut self,
input: std::option::Option<crate::types::InputConfig>,
) -> Self {
self.inner = self.inner.set_input_config(input);
self
}
/// <p>Provides information about the output location for the compiled model and the target device the model runs on.</p>
pub fn output_config(mut self, input: crate::types::OutputConfig) -> Self {
self.inner = self.inner.output_config(input);
self
}
/// <p>Provides information about the output location for the compiled model and the target device the model runs on.</p>
pub fn set_output_config(
mut self,
input: std::option::Option<crate::types::OutputConfig>,
) -> Self {
self.inner = self.inner.set_output_config(input);
self
}
/// <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html">VpcConfig</a> object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html">Protect Compilation Jobs by Using an Amazon Virtual Private Cloud</a>.</p>
pub fn vpc_config(mut self, input: crate::types::NeoVpcConfig) -> Self {
self.inner = self.inner.vpc_config(input);
self
}
/// <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html">VpcConfig</a> object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html">Protect Compilation Jobs by Using an Amazon Virtual Private Cloud</a>.</p>
pub fn set_vpc_config(
mut self,
input: std::option::Option<crate::types::NeoVpcConfig>,
) -> Self {
self.inner = self.inner.set_vpc_config(input);
self
}
/// <p>Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.</p>
pub fn stopping_condition(mut self, input: crate::types::StoppingCondition) -> Self {
self.inner = self.inner.stopping_condition(input);
self
}
/// <p>Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.</p>
pub fn set_stopping_condition(
mut self,
input: std::option::Option<crate::types::StoppingCondition>,
) -> Self {
self.inner = self.inner.set_stopping_condition(input);
self
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</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
}
}