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

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

Overview

Note:

When making an API call, you may pass RecommendationJobInputConfig data as a hash:

{
  model_package_version_arn: "ModelPackageArn", # required
  job_duration_in_seconds: 1,
  traffic_pattern: {
    traffic_type: "PHASES", # accepts PHASES
    phases: [
      {
        initial_number_of_users: 1,
        spawn_rate: 1,
        duration_in_seconds: 1,
      },
    ],
  },
  resource_limit: {
    max_number_of_tests: 1,
    max_parallel_of_tests: 1,
  },
  endpoint_configurations: [
    {
      instance_type: "ml.t2.medium", # required, accepts ml.t2.medium, ml.t2.large, ml.t2.xlarge, ml.t2.2xlarge, ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.m5d.large, ml.m5d.xlarge, ml.m5d.2xlarge, ml.m5d.4xlarge, ml.m5d.12xlarge, ml.m5d.24xlarge, ml.c4.large, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.c5d.large, ml.c5d.xlarge, ml.c5d.2xlarge, ml.c5d.4xlarge, ml.c5d.9xlarge, ml.c5d.18xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.12xlarge, ml.r5.24xlarge, ml.r5d.large, ml.r5d.xlarge, ml.r5d.2xlarge, ml.r5d.4xlarge, ml.r5d.12xlarge, ml.r5d.24xlarge, ml.inf1.xlarge, ml.inf1.2xlarge, ml.inf1.6xlarge, ml.inf1.24xlarge
      inference_specification_name: "InferenceSpecificationName",
      environment_parameter_ranges: {
        categorical_parameter_ranges: [
          {
            name: "String64", # required
            value: ["String128"], # required
          },
        ],
      },
    },
  ],
  volume_kms_key_id: "KmsKeyId",
}

The input configuration of the recommendation job.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#endpoint_configurationsArray<Types::EndpointInputConfiguration>

Specifies the endpoint configuration to use for a job.



34281
34282
34283
34284
34285
34286
34287
34288
34289
34290
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 34281

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

#job_duration_in_secondsInteger

Specifies the maximum duration of the job, in seconds.>

Returns:

  • (Integer)


34281
34282
34283
34284
34285
34286
34287
34288
34289
34290
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 34281

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

#model_package_version_arnString

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

Returns:

  • (String)


34281
34282
34283
34284
34285
34286
34287
34288
34289
34290
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 34281

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

#resource_limitTypes::RecommendationJobResourceLimit

Defines the resource limit of the job.



34281
34282
34283
34284
34285
34286
34287
34288
34289
34290
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 34281

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

#traffic_patternTypes::TrafficPattern

Specifies the traffic pattern of the job.



34281
34282
34283
34284
34285
34286
34287
34288
34289
34290
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 34281

class RecommendationJobInputConfig < Struct.new(
  :model_package_version_arn,
  :job_duration_in_seconds,
  :traffic_pattern,
  :resource_limit,
  :endpoint_configurations,
  :volume_kms_key_id)
  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)


34281
34282
34283
34284
34285
34286
34287
34288
34289
34290
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 34281

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