aws_sdk_sagemaker/client/

describe_inference_experiment.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeInferenceExperiment`](crate::operation::describe_inference_experiment::builders::DescribeInferenceExperimentFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::describe_inference_experiment::builders::DescribeInferenceExperimentFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::describe_inference_experiment::builders::DescribeInferenceExperimentFluentBuilder::set_name):<br>required: **true**<br><p>The name of the inference experiment to describe.</p><br>
    /// - On success, responds with [`DescribeInferenceExperimentOutput`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentOutput) with field(s):
    ///   - [`arn(Option<String>)`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentOutput::arn): <p>The ARN of the inference experiment being described.</p>
    ///   - [`name(Option<String>)`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentOutput::name): <p>The name of the inference experiment.</p>
    ///   - [`r#type(Option<InferenceExperimentType>)`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentOutput::type): <p>The type of the inference experiment.</p>
    ///   - [`schedule(Option<InferenceExperimentSchedule>)`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentOutput::schedule): <p>The duration for which the inference experiment ran or will run.</p>
    ///   - [`status(Option<InferenceExperimentStatus>)`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentOutput::status): <p>The status of the inference experiment. The following are the possible statuses for an inference experiment:</p> <ul>  <li>   <p><code>Creating</code> - Amazon SageMaker is creating your experiment.</p></li>  <li>   <p><code>Created</code> - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.</p></li>  <li>   <p><code>Updating</code> - When you make changes to your experiment, your experiment shows as updating.</p></li>  <li>   <p><code>Starting</code> - Amazon SageMaker is beginning your experiment.</p></li>  <li>   <p><code>Running</code> - Your experiment is in progress.</p></li>  <li>   <p><code>Stopping</code> - Amazon SageMaker is stopping your experiment.</p></li>  <li>   <p><code>Completed</code> - Your experiment has completed.</p></li>  <li>   <p><code>Cancelled</code> - When you conclude your experiment early using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html">StopInferenceExperiment</a> API, or if any operation fails with an unexpected error, it shows as cancelled.</p></li> </ul>
    ///   - [`status_reason(Option<String>)`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentOutput::status_reason): <p>The error message or client-specified <code>Reason</code> from the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html">StopInferenceExperiment</a> API, that explains the status of the inference experiment.</p>
    ///   - [`description(Option<String>)`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentOutput::description): <p>The description of the inference experiment.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentOutput::creation_time): <p>The timestamp at which you created the inference experiment.</p>
    ///   - [`completion_time(Option<DateTime>)`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentOutput::completion_time): <p>The timestamp at which the inference experiment was completed.</p>
    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentOutput::last_modified_time): <p>The timestamp at which you last modified the inference experiment.</p>
    ///   - [`role_arn(Option<String>)`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentOutput::role_arn): <p>The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.</p>
    ///   - [`endpoint_metadata(Option<EndpointMetadata>)`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentOutput::endpoint_metadata): <p>The metadata of the endpoint on which the inference experiment ran.</p>
    ///   - [`model_variants(Option<Vec::<ModelVariantConfigSummary>>)`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentOutput::model_variants): <p>An array of <code>ModelVariantConfigSummary</code> objects. There is one for each variant in the inference experiment. Each <code>ModelVariantConfigSummary</code> object in the array describes the infrastructure configuration for deploying the corresponding variant.</p>
    ///   - [`data_storage_config(Option<InferenceExperimentDataStorageConfig>)`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentOutput::data_storage_config): <p>The Amazon S3 location and configuration for storing inference request and response data.</p>
    ///   - [`shadow_mode_config(Option<ShadowModeConfig>)`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentOutput::shadow_mode_config): <p>The configuration of <code>ShadowMode</code> inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.</p>
    ///   - [`kms_key(Option<String>)`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentOutput::kms_key): <p>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html">CreateInferenceExperiment</a>.</p>
    /// - On failure, responds with [`SdkError<DescribeInferenceExperimentError>`](crate::operation::describe_inference_experiment::DescribeInferenceExperimentError)
    pub fn describe_inference_experiment(
        &self,
    ) -> crate::operation::describe_inference_experiment::builders::DescribeInferenceExperimentFluentBuilder {
        crate::operation::describe_inference_experiment::builders::DescribeInferenceExperimentFluentBuilder::new(self.handle.clone())
    }
}