Struct CreateInferenceRecommendationsJobInput

#[non_exhaustive]
pub struct CreateInferenceRecommendationsJobInput {
    pub job_name: Option<String>,
    pub job_type: Option<RecommendationJobType>,
    pub role_arn: Option<String>,
    pub input_config: Option<RecommendationJobInputConfig>,
    pub job_description: Option<String>,
    pub stopping_conditions: Option<RecommendationJobStoppingConditions>,
    pub output_config: Option<RecommendationJobOutputConfig>,
    pub tags: Option<Vec<Tag>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

job_name: Option<String>

A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

job_type: Option<RecommendationJobType>

Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

role_arn: Option<String>

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

input_config: Option<RecommendationJobInputConfig>

Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

job_description: Option<String>

Description of the recommendation job.

stopping_conditions: Option<RecommendationJobStoppingConditions>

A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

output_config: Option<RecommendationJobOutputConfig>

Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

tags: Option<Vec<Tag>>

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Implementations

impl CreateInferenceRecommendationsJobInput

pub fn job_name(&self) -> Option<&str>

A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

pub fn job_type(&self) -> Option<&RecommendationJobType>

Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

pub fn role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

pub fn input_config(&self) -> Option<&RecommendationJobInputConfig>

Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

pub fn job_description(&self) -> Option<&str>

Description of the recommendation job.

pub fn stopping_conditions( &self, ) -> Option<&RecommendationJobStoppingConditions>

A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

pub fn output_config(&self) -> Option<&RecommendationJobOutputConfig>

Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

pub fn tags(&self) -> &[Tag]

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

impl CreateInferenceRecommendationsJobInput

pub fn builder() -> CreateInferenceRecommendationsJobInputBuilder

Creates a new builder-style object to manufacture CreateInferenceRecommendationsJobInput.

Trait Implementations

impl Clone for CreateInferenceRecommendationsJobInput

fn clone(&self) -> CreateInferenceRecommendationsJobInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateInferenceRecommendationsJobInput

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

Formats the value using the given formatter.

impl PartialEq for CreateInferenceRecommendationsJobInput

fn eq(&self, other: &CreateInferenceRecommendationsJobInput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateInferenceRecommendationsJobInput