aws_sdk_sagemaker/client/describe_model_explainability_job_definition.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`DescribeModelExplainabilityJobDefinition`](crate::operation::describe_model_explainability_job_definition::builders::DescribeModelExplainabilityJobDefinitionFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`job_definition_name(impl Into<String>)`](crate::operation::describe_model_explainability_job_definition::builders::DescribeModelExplainabilityJobDefinitionFluentBuilder::job_definition_name) / [`set_job_definition_name(Option<String>)`](crate::operation::describe_model_explainability_job_definition::builders::DescribeModelExplainabilityJobDefinitionFluentBuilder::set_job_definition_name):<br>required: **true**<br><p>The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p><br>
7 /// - On success, responds with [`DescribeModelExplainabilityJobDefinitionOutput`](crate::operation::describe_model_explainability_job_definition::DescribeModelExplainabilityJobDefinitionOutput) with field(s):
8 /// - [`job_definition_arn(Option<String>)`](crate::operation::describe_model_explainability_job_definition::DescribeModelExplainabilityJobDefinitionOutput::job_definition_arn): <p>The Amazon Resource Name (ARN) of the model explainability job.</p>
9 /// - [`job_definition_name(Option<String>)`](crate::operation::describe_model_explainability_job_definition::DescribeModelExplainabilityJobDefinitionOutput::job_definition_name): <p>The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p>
10 /// - [`creation_time(Option<DateTime>)`](crate::operation::describe_model_explainability_job_definition::DescribeModelExplainabilityJobDefinitionOutput::creation_time): <p>The time at which the model explainability job was created.</p>
11 /// - [`model_explainability_baseline_config(Option<ModelExplainabilityBaselineConfig>)`](crate::operation::describe_model_explainability_job_definition::DescribeModelExplainabilityJobDefinitionOutput::model_explainability_baseline_config): <p>The baseline configuration for a model explainability job.</p>
12 /// - [`model_explainability_app_specification(Option<ModelExplainabilityAppSpecification>)`](crate::operation::describe_model_explainability_job_definition::DescribeModelExplainabilityJobDefinitionOutput::model_explainability_app_specification): <p>Configures the model explainability job to run a specified Docker container image.</p>
13 /// - [`model_explainability_job_input(Option<ModelExplainabilityJobInput>)`](crate::operation::describe_model_explainability_job_definition::DescribeModelExplainabilityJobDefinitionOutput::model_explainability_job_input): <p>Inputs for the model explainability job.</p>
14 /// - [`model_explainability_job_output_config(Option<MonitoringOutputConfig>)`](crate::operation::describe_model_explainability_job_definition::DescribeModelExplainabilityJobDefinitionOutput::model_explainability_job_output_config): <p>The output configuration for monitoring jobs.</p>
15 /// - [`job_resources(Option<MonitoringResources>)`](crate::operation::describe_model_explainability_job_definition::DescribeModelExplainabilityJobDefinitionOutput::job_resources): <p>Identifies the resources to deploy for a monitoring job.</p>
16 /// - [`network_config(Option<MonitoringNetworkConfig>)`](crate::operation::describe_model_explainability_job_definition::DescribeModelExplainabilityJobDefinitionOutput::network_config): <p>Networking options for a model explainability job.</p>
17 /// - [`role_arn(Option<String>)`](crate::operation::describe_model_explainability_job_definition::DescribeModelExplainabilityJobDefinitionOutput::role_arn): <p>The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.</p>
18 /// - [`stopping_condition(Option<MonitoringStoppingCondition>)`](crate::operation::describe_model_explainability_job_definition::DescribeModelExplainabilityJobDefinitionOutput::stopping_condition): <p>A time limit for how long the monitoring job is allowed to run before stopping.</p>
19 /// - On failure, responds with [`SdkError<DescribeModelExplainabilityJobDefinitionError>`](crate::operation::describe_model_explainability_job_definition::DescribeModelExplainabilityJobDefinitionError)
20 pub fn describe_model_explainability_job_definition(
21 &self,
22 ) -> crate::operation::describe_model_explainability_job_definition::builders::DescribeModelExplainabilityJobDefinitionFluentBuilder {
23 crate::operation::describe_model_explainability_job_definition::builders::DescribeModelExplainabilityJobDefinitionFluentBuilder::new(
24 self.handle.clone(),
25 )
26 }
27}