Struct RecommendationJobInputConfig

#[non_exhaustive]
pub struct RecommendationJobInputConfig {
    pub model_package_version_arn: Option<String>,
    pub model_name: Option<String>,
    pub job_duration_in_seconds: Option<i32>,
    pub traffic_pattern: Option<TrafficPattern>,
    pub resource_limit: Option<RecommendationJobResourceLimit>,
    pub endpoint_configurations: Option<Vec<EndpointInputConfiguration>>,
    pub volume_kms_key_id: Option<String>,
    pub container_config: Option<RecommendationJobContainerConfig>,
    pub endpoints: Option<Vec<EndpointInfo>>,
    pub vpc_config: Option<RecommendationJobVpcConfig>,
}

The input configuration of the recommendation job.

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.

model_package_version_arn: Option<String>

The Amazon Resource Name (ARN) of a versioned model package.

model_name: Option<String>

The name of the created model.

job_duration_in_seconds: Option<i32>

Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.

traffic_pattern: Option<TrafficPattern>

Specifies the traffic pattern of the job.

resource_limit: Option<RecommendationJobResourceLimit>

Defines the resource limit of the job.

endpoint_configurations: Option<Vec<EndpointInputConfiguration>>

Specifies the endpoint configuration to use for a job.

volume_kms_key_id: Option<String>

The Amazon Resource Name (ARN) of a 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. This key will be passed to SageMaker Hosting for endpoint creation.

The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.

The KmsKeyId can be any of the following formats:

• // KMS Key ID

  "1234abcd-12ab-34cd-56ef-1234567890ab"

• // Amazon Resource Name (ARN) of a KMS Key

  "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

• // KMS Key Alias

  "alias/ExampleAlias"

• // Amazon Resource Name (ARN) of a KMS Key Alias

  "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

container_config: Option<RecommendationJobContainerConfig>

Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.

endpoints: Option<Vec<EndpointInfo>>

Existing customer endpoints on which to run an Inference Recommender job.

vpc_config: Option<RecommendationJobVpcConfig>

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

Implementations

impl RecommendationJobInputConfig

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

The Amazon Resource Name (ARN) of a versioned model package.

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

The name of the created model.

pub fn job_duration_in_seconds(&self) -> Option<i32>

Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.

pub fn traffic_pattern(&self) -> Option<&TrafficPattern>

Specifies the traffic pattern of the job.

pub fn resource_limit(&self) -> Option<&RecommendationJobResourceLimit>

Defines the resource limit of the job.

pub fn endpoint_configurations(&self) -> &[EndpointInputConfiguration]

Specifies the endpoint configuration to use for a job.

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

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

The Amazon Resource Name (ARN) of a 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. This key will be passed to SageMaker Hosting for endpoint creation.

The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.

The KmsKeyId can be any of the following formats:

• // KMS Key ID

  "1234abcd-12ab-34cd-56ef-1234567890ab"

• // Amazon Resource Name (ARN) of a KMS Key

  "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

• // KMS Key Alias

  "alias/ExampleAlias"

• // Amazon Resource Name (ARN) of a KMS Key Alias

  "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

pub fn container_config(&self) -> Option<&RecommendationJobContainerConfig>

Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.

pub fn endpoints(&self) -> &[EndpointInfo]

Existing customer endpoints on which to run an Inference Recommender job.

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

pub fn vpc_config(&self) -> Option<&RecommendationJobVpcConfig>

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

impl RecommendationJobInputConfig

pub fn builder() -> RecommendationJobInputConfigBuilder

Creates a new builder-style object to manufacture RecommendationJobInputConfig.

Trait Implementations

impl Clone for RecommendationJobInputConfig

fn clone(&self) -> RecommendationJobInputConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecommendationJobInputConfig

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

Formats the value using the given formatter.

impl PartialEq for RecommendationJobInputConfig

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

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

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 RecommendationJobInputConfig