/AWS1/CL_SGMPROCINGCLUSTCONFIG¶
Configuration for the cluster used to run a processing job.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_volumesizeingb TYPE /AWS1/SGMPROCINGVOLUMESIZEINGB /AWS1/SGMPROCINGVOLUMESIZEINGB¶
The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.
Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a
VolumeSizeInGBgreater than the total size of the local instance storage.For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
Optional arguments:¶
iv_instancecount TYPE /AWS1/SGMPROCESSINGINSTCOUNT /AWS1/SGMPROCESSINGINSTCOUNT¶
The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.
iv_instancetype TYPE /AWS1/SGMPROCESSINGINSTTYPE /AWS1/SGMPROCESSINGINSTTYPE¶
The ML compute instance type for the processing job.
iv_volumekmskeyid TYPE /AWS1/SGMKMSKEYID /AWS1/SGMKMSKEYID¶
The 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(s) that run the processing job.
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a
VolumeKmsKeyIdwhen using an instance type with local storage.For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
it_instancepreferences TYPE /AWS1/CL_SGMPRCSGINSTANCEPREF=>TT_PROCESSINGINSTANCEPREFLIST TT_PROCESSINGINSTANCEPREFLIST¶
An ordered list of ML compute instance types for the processing job, in priority order. Amazon SageMaker launches the job on the first instance type in the list that has available capacity. If capacity is insufficient, Amazon SageMaker evaluates the next instance type in the list. Exactly one instance type is selected for the job.
InstancePreferencesis mutually exclusive withInstanceType.
iv_selectedinstancetype TYPE /AWS1/SGMPROCESSINGINSTTYPE /AWS1/SGMPROCESSINGINSTTYPE¶
The instance type that Amazon SageMaker selected for the job from
InstancePreferences. Returned byDescribeProcessingJobafter an instance type is selected. This field is read-only and isn't accepted inCreateProcessingJobrequests.
iv_selectedinstancecount TYPE /AWS1/SGMPROCESSINGINSTCOUNT /AWS1/SGMPROCESSINGINSTCOUNT¶
The number of instances of
SelectedInstanceTypethat the job launched with. The job is billed for this instance type and count. Returned byDescribeProcessingJobafter an instance type is selected. This field is read-only and isn't accepted inCreateProcessingJobrequests.
Queryable Attributes¶
InstanceCount¶
The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.
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 |
InstanceType¶
The ML compute instance type for the processing job.
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 |
VolumeSizeInGB¶
The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.
Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a
VolumeSizeInGBgreater than the total size of the local instance storage.For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VOLUMESIZEINGB() |
Getter for VOLUMESIZEINGB, with configurable default |
ASK_VOLUMESIZEINGB() |
Getter for VOLUMESIZEINGB w/ exceptions if field has no valu |
HAS_VOLUMESIZEINGB() |
Determine if VOLUMESIZEINGB has a value |
VolumeKmsKeyId¶
The 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(s) that run the processing job.
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a
VolumeKmsKeyIdwhen using an instance type with local storage.For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VOLUMEKMSKEYID() |
Getter for VOLUMEKMSKEYID, with configurable default |
ASK_VOLUMEKMSKEYID() |
Getter for VOLUMEKMSKEYID w/ exceptions if field has no valu |
HAS_VOLUMEKMSKEYID() |
Determine if VOLUMEKMSKEYID has a value |
InstancePreferences¶
An ordered list of ML compute instance types for the processing job, in priority order. Amazon SageMaker launches the job on the first instance type in the list that has available capacity. If capacity is insufficient, Amazon SageMaker evaluates the next instance type in the list. Exactly one instance type is selected for the job.
InstancePreferencesis mutually exclusive withInstanceType.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INSTANCEPREFERENCES() |
Getter for INSTANCEPREFERENCES, with configurable default |
ASK_INSTANCEPREFERENCES() |
Getter for INSTANCEPREFERENCES w/ exceptions if field has no |
HAS_INSTANCEPREFERENCES() |
Determine if INSTANCEPREFERENCES has a value |
SelectedInstanceType¶
The instance type that Amazon SageMaker selected for the job from
InstancePreferences. Returned byDescribeProcessingJobafter an instance type is selected. This field is read-only and isn't accepted inCreateProcessingJobrequests.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SELECTEDINSTANCETYPE() |
Getter for SELECTEDINSTANCETYPE, with configurable default |
ASK_SELECTEDINSTANCETYPE() |
Getter for SELECTEDINSTANCETYPE w/ exceptions if field has n |
HAS_SELECTEDINSTANCETYPE() |
Determine if SELECTEDINSTANCETYPE has a value |
SelectedInstanceCount¶
The number of instances of
SelectedInstanceTypethat the job launched with. The job is billed for this instance type and count. Returned byDescribeProcessingJobafter an instance type is selected. This field is read-only and isn't accepted inCreateProcessingJobrequests.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SELECTEDINSTANCECOUNT() |
Getter for SELECTEDINSTANCECOUNT, with configurable default |
ASK_SELECTEDINSTANCECOUNT() |
Getter for SELECTEDINSTANCECOUNT w/ exceptions if field has |
HAS_SELECTEDINSTANCECOUNT() |
Determine if SELECTEDINSTANCECOUNT has a value |