/AWS1/CL_SGMINSTANCEPREFERENCE

A candidate instance type preference in an InstancePreferences list.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_instancetype TYPE /AWS1/SGMTRAININGINSTANCETYPE /AWS1/SGMTRAININGINSTANCETYPE

The ML compute instance type. An instance type can appear only once in an InstancePreferences list.

Optional arguments:

iv_instancecount TYPE /AWS1/SGMTRAININGINSTANCECOUNT /AWS1/SGMTRAININGINSTANCECOUNT

The number of instances to launch if this instance type is selected. Specify the instance count for the training job in one of the following two ways:

1. Per preference – Set InstanceCount on every preference in the InstancePreferences list and don't set ResourceConfig$InstanceCount. Use this when each instance type needs a different number of instances to deliver equivalent compute.

2. One count for the job – Set ResourceConfig$InstanceCount and omit it from every preference. SageMaker applies this to all instance types in the list.

For example, in a list of five preferences, either all five specify InstanceCount or none of them do. SageMaker rejects requests that set InstanceCount on only some preferences, that set it both per preference and in ResourceConfig, or that omit it in both places.

it_trainingplanarns TYPE /AWS1/CL_SGMTRNPLANARNLIST_W=>TT_TRAININGPLANARNLIST TT_TRAININGPLANARNLIST

The Amazon Resource Name (ARN) of a training plan to use if this instance type is selected. The plan's instance type must match InstanceType. A preference with a training plan uses that plan's reserved capacity; a preference without one uses on-demand capacity. Per-preference TrainingPlanArns is mutually exclusive with the job-level TrainingPlanArn in ResourceConfig.

---

Queryable Attributes

InstanceType

The ML compute instance type. An instance type can appear only once in an InstancePreferences list.

Accessible with the following methods

Method	Description
GET_INSTANCETYPE()	Getter for INSTANCETYPE, with configurable default
ASK_INSTANCETYPE()	Getter for INSTANCETYPE w/ exceptions if field has no value
HAS_INSTANCETYPE()	Determine if INSTANCETYPE has a value

InstanceCount

The number of instances to launch if this instance type is selected. Specify the instance count for the training job in one of the following two ways:

1. Per preference – Set InstanceCount on every preference in the InstancePreferences list and don't set ResourceConfig$InstanceCount. Use this when each instance type needs a different number of instances to deliver equivalent compute.

2. One count for the job – Set ResourceConfig$InstanceCount and omit it from every preference. SageMaker applies this to all instance types in the list.

For example, in a list of five preferences, either all five specify InstanceCount or none of them do. SageMaker rejects requests that set InstanceCount on only some preferences, that set it both per preference and in ResourceConfig, or that omit it in both places.

Accessible with the following methods

Method	Description
GET_INSTANCECOUNT()	Getter for INSTANCECOUNT, with configurable default
ASK_INSTANCECOUNT()	Getter for INSTANCECOUNT w/ exceptions if field has no value
HAS_INSTANCECOUNT()	Determine if INSTANCECOUNT has a value

TrainingPlanArns

The Amazon Resource Name (ARN) of a training plan to use if this instance type is selected. The plan's instance type must match InstanceType. A preference with a training plan uses that plan's reserved capacity; a preference without one uses on-demand capacity. Per-preference TrainingPlanArns is mutually exclusive with the job-level TrainingPlanArn in ResourceConfig.

Accessible with the following methods

Method	Description
GET_TRAININGPLANARNS()	Getter for TRAININGPLANARNS, with configurable default
ASK_TRAININGPLANARNS()	Getter for TRAININGPLANARNS w/ exceptions if field has no va
HAS_TRAININGPLANARNS()	Determine if TRAININGPLANARNS has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_INSTANCEPREFERENCELIST

TYPES TT_INSTANCEPREFERENCELIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_SGMINSTANCEPREFERENCE WITH DEFAULT KEY
.