Struct aws_sdk_lookoutvision::client::fluent_builders::StartModelPackagingJob

pub struct StartModelPackagingJob { /* private fields */ }

Fluent builder constructing a request to StartModelPackagingJob.

Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass.

Use the DescribeModelPackagingJob API to determine the current status of the job. The model packaging job is complete if the value of Status is SUCCEEDED.

To deploy the component to the target device, use the component name and component version with the AWS IoT Greengrass CreateDeployment API.

This operation requires the following permissions:

• lookoutvision:StartModelPackagingJob

• s3:PutObject

• s3:GetBucketLocation

• greengrass:CreateComponentVersion

• greengrass:DescribeComponent

• (Optional) greengrass:TagResource. Only required if you want to tag the component.

For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.

Implementations

impl StartModelPackagingJob

pub async fn send(
    self
) -> Result<StartModelPackagingJobOutput, SdkError<StartModelPackagingJobError>>

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 project_name(self, input: impl Into<String>) -> Self

The name of the project which contains the version of the model that you want to package.

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

The name of the project which contains the version of the model that you want to package.

pub fn model_version(self, input: impl Into<String>) -> Self

The version of the model within the project that you want to package.

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

The version of the model within the project that you want to package.

pub fn job_name(self, input: impl Into<String>) -> Self

A name for the model packaging job. If you don't supply a value, the service creates a job name for you.

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

A name for the model packaging job. If you don't supply a value, the service creates a job name for you.

pub fn configuration(self, input: ModelPackagingConfiguration) -> Self

The configuration for the model packaging job.

pub fn set_configuration(
    self,
    input: Option<ModelPackagingConfiguration>
) -> Self

The configuration for the model packaging job.

pub fn description(self, input: impl Into<String>) -> Self

A description for the model packaging job.

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

A description for the model packaging job.

pub fn client_token(self, input: impl Into<String>) -> Self

ClientToken is an idempotency token that ensures a call to StartModelPackagingJob completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from StartModelPackagingJob. In this case, safely retry your call to StartModelPackagingJob by using the same ClientToken parameter value.

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple dataset creation requests. You'll need to provide your own value for other use cases.

An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to StartModelPackagingJob. An idempotency token is active for 8 hours.

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

ClientToken is an idempotency token that ensures a call to StartModelPackagingJob completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from StartModelPackagingJob. In this case, safely retry your call to StartModelPackagingJob by using the same ClientToken parameter value.

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple dataset creation requests. You'll need to provide your own value for other use cases.

An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to StartModelPackagingJob. An idempotency token is active for 8 hours.

Trait Implementations

impl Clone for StartModelPackagingJob

fn clone(&self) -> StartModelPackagingJob

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartModelPackagingJob

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

Formats the value using the given formatter.