Class: Aws::SageMaker::Types::RecommendationJobInputConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

The input configuration of the recommendation job.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#container_configTypes::RecommendationJobContainerConfig

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



36932
36933
36934
36935
36936
36937
36938
36939
36940
36941
36942
36943
36944
36945
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 36932

class RecommendationJobInputConfig < Struct.new(
  :model_package_version_arn,
  :model_name,
  :job_duration_in_seconds,
  :traffic_pattern,
  :resource_limit,
  :endpoint_configurations,
  :volume_kms_key_id,
  :container_config,
  :endpoints,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_configurationsArray<Types::EndpointInputConfiguration>

Specifies the endpoint configuration to use for a job.



36932
36933
36934
36935
36936
36937
36938
36939
36940
36941
36942
36943
36944
36945
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 36932

class RecommendationJobInputConfig < Struct.new(
  :model_package_version_arn,
  :model_name,
  :job_duration_in_seconds,
  :traffic_pattern,
  :resource_limit,
  :endpoint_configurations,
  :volume_kms_key_id,
  :container_config,
  :endpoints,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#endpointsArray<Types::EndpointInfo>

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

Returns:



36932
36933
36934
36935
36936
36937
36938
36939
36940
36941
36942
36943
36944
36945
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 36932

class RecommendationJobInputConfig < Struct.new(
  :model_package_version_arn,
  :model_name,
  :job_duration_in_seconds,
  :traffic_pattern,
  :resource_limit,
  :endpoint_configurations,
  :volume_kms_key_id,
  :container_config,
  :endpoints,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#job_duration_in_secondsInteger

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

Returns:

  • (Integer)


36932
36933
36934
36935
36936
36937
36938
36939
36940
36941
36942
36943
36944
36945
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 36932

class RecommendationJobInputConfig < Struct.new(
  :model_package_version_arn,
  :model_name,
  :job_duration_in_seconds,
  :traffic_pattern,
  :resource_limit,
  :endpoint_configurations,
  :volume_kms_key_id,
  :container_config,
  :endpoints,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#model_nameString

The name of the created model.

Returns:

  • (String)


36932
36933
36934
36935
36936
36937
36938
36939
36940
36941
36942
36943
36944
36945
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 36932

class RecommendationJobInputConfig < Struct.new(
  :model_package_version_arn,
  :model_name,
  :job_duration_in_seconds,
  :traffic_pattern,
  :resource_limit,
  :endpoint_configurations,
  :volume_kms_key_id,
  :container_config,
  :endpoints,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#model_package_version_arnString

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

Returns:

  • (String)


36932
36933
36934
36935
36936
36937
36938
36939
36940
36941
36942
36943
36944
36945
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 36932

class RecommendationJobInputConfig < Struct.new(
  :model_package_version_arn,
  :model_name,
  :job_duration_in_seconds,
  :traffic_pattern,
  :resource_limit,
  :endpoint_configurations,
  :volume_kms_key_id,
  :container_config,
  :endpoints,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#resource_limitTypes::RecommendationJobResourceLimit

Defines the resource limit of the job.



36932
36933
36934
36935
36936
36937
36938
36939
36940
36941
36942
36943
36944
36945
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 36932

class RecommendationJobInputConfig < Struct.new(
  :model_package_version_arn,
  :model_name,
  :job_duration_in_seconds,
  :traffic_pattern,
  :resource_limit,
  :endpoint_configurations,
  :volume_kms_key_id,
  :container_config,
  :endpoints,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_patternTypes::TrafficPattern

Specifies the traffic pattern of the job.



36932
36933
36934
36935
36936
36937
36938
36939
36940
36941
36942
36943
36944
36945
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 36932

class RecommendationJobInputConfig < Struct.new(
  :model_package_version_arn,
  :model_name,
  :job_duration_in_seconds,
  :traffic_pattern,
  :resource_limit,
  :endpoint_configurations,
  :volume_kms_key_id,
  :container_config,
  :endpoints,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#volume_kms_key_idString

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.

Returns:

  • (String)


36932
36933
36934
36935
36936
36937
36938
36939
36940
36941
36942
36943
36944
36945
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 36932

class RecommendationJobInputConfig < Struct.new(
  :model_package_version_arn,
  :model_name,
  :job_duration_in_seconds,
  :traffic_pattern,
  :resource_limit,
  :endpoint_configurations,
  :volume_kms_key_id,
  :container_config,
  :endpoints,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configTypes::RecommendationJobVpcConfig

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



36932
36933
36934
36935
36936
36937
36938
36939
36940
36941
36942
36943
36944
36945
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 36932

class RecommendationJobInputConfig < Struct.new(
  :model_package_version_arn,
  :model_name,
  :job_duration_in_seconds,
  :traffic_pattern,
  :resource_limit,
  :endpoint_configurations,
  :volume_kms_key_id,
  :container_config,
  :endpoints,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end