String trainingImage
The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for built-in algorithms, see sagemaker-algo-docker-registry-paths.
String trainingInputMode
The input mode that the algorithm supports. For the input modes that Amazon SageMaker algorithms support, see Algorithms. If an algorithm supports the
File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage
Volume, and mounts the directory to docker volume for training container. If an algorithm supports the
Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.
In File mode, make sure you provision ML storage volume with sufficient capacity to accommodate the data download from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container use ML storage volume to also store intermediate information, if any.
For distributed algorithms using File mode, training data is distributed uniformly, and your training duration is predictable if the input data objects size is approximately same. Amazon SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed where one host in a training cluster is overloaded, thus becoming bottleneck in training.
String channelName
The name of the channel.
DataSource dataSource
The location of the channel data.
String contentType
The MIME type of the data.
String compressionType
If training data is compressed, the compression type. The default value is None.
CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to
None.
String recordWrapperType
Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format, in which case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
In FILE mode, leave this field unset or set it to None.
String containerHostname
The DNS host name for the container after Amazon SageMaker deploys it.
String image
The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. If you are using your own
custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon
SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and
registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon
SageMaker
String modelDataUrl
The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS i an AWS Region in the AWS Identity and Access Management User Guide.
Map<K,V> environment
The environment variables to set in the Docker container. Each key and value in the Environment
string to string map can have length of up to 1024. We support up to 16 entries in the map.
String name
The name of the continuous hyperparameter to tune.
String minValue
The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and
MaxValuefor tuning.
String maxValue
The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue
value and this value for tuning.
String endpointConfigName
The name of the endpoint configuration. You specify this name in a CreateEndpoint request.
List<E> productionVariants
An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
List<E> tags
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
String kmsKeyId
The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
String endpointConfigArn
The Amazon Resource Name (ARN) of the endpoint configuration.
String endpointName
The name of the endpoint. The name must be unique within an AWS Region in your AWS account.
String endpointConfigName
The name of an endpoint configuration. For more information, see CreateEndpointConfig.
List<E> tags
An array of key-value pairs. For more information, see Using Cost Allocation Tagsin the AWS Billing and Cost Management User Guide.
String endpointArn
The Amazon Resource Name (ARN) of the endpoint.
String hyperParameterTuningJobName
The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same AWS account and AWS Region. Names are not case sensitive, and must be between 1-32 characters.
HyperParameterTuningJobConfig hyperParameterTuningJobConfig
The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job.
HyperParameterTrainingJobDefinition trainingJobDefinition
The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.
List<E> tags
An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
String hyperParameterTuningJobArn
The Amazon Resource Name (ARN) of the tuning job.
String modelName
The name of the new model.
ContainerDefinition primaryContainer
The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.
String executionRoleArn
The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see Amazon SageMaker Roles.
To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole
permission.
List<E> tags
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
VpcConfig vpcConfig
String modelArn
The ARN of the model created in Amazon SageMaker.
String notebookInstanceLifecycleConfigName
The name of the lifecycle configuration.
List<E> onCreate
A shell script that runs only once, when you create a notebook instance.
List<E> onStart
A shell script that runs every time you start a notebook instance, including when you create the notebook instance.
String notebookInstanceLifecycleConfigArn
The Amazon Resource Name (ARN) of the lifecycle configuration.
String notebookInstanceName
The name of the new notebook instance.
String instanceType
The type of ML compute instance to launch for the notebook instance.
String subnetId
The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
List<E> securityGroupIds
The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
String roleArn
When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see Amazon SageMaker Roles.
To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole
permission.
String kmsKeyId
If you provide a AWS KMS key ID, Amazon SageMaker uses it to encrypt data at rest on the ML storage volume that is attached to your notebook instance.
List<E> tags
A list of tags to associate with the notebook instance. You can add tags later by using the
CreateTags API.
String lifecycleConfigName
The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see notebook-lifecycle-config.
String directInternetAccess
Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this to
Disabled this notebook instance will be able to access resources only in your VPC, and will not be
able to connect to Amazon SageMaker training and endpoint services unless your configure a NAT Gateway in your
VPC.
For more information, see appendix-notebook-and-internet-access. You can set the value of this parameter
to Disabled only if you set a value for the SubnetId parameter.
String notebookInstanceArn
The Amazon Resource Name (ARN) of the notebook instance.
String authorizedUrl
A JSON object that contains the URL string.
String trainingJobName
The name of the training job. The name must be unique within an AWS Region in an AWS account.
Map<K,V> hyperParameters
Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms.
You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is
limited to 256 characters, as specified by the Length Constraint.
AlgorithmSpecification algorithmSpecification
The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by Amazon SageMaker, see Algorithms. For information about providing your own algorithms, see your-algorithms.
String roleArn
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
During model training, Amazon SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see Amazon SageMaker Roles.
To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole
permission.
List<E> inputDataConfig
An array of Channel objects. Each channel is a named input source. InputDataConfig
describes the input data and its location.
Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of
input data, training_data and validation_data. The configuration for each channel
provides the S3 location where the input data is stored. It also provides information about the stored data: the
MIME type, compression method, and whether the data is wrapped in RecordIO format.
Depending on the input mode that the algorithm supports, Amazon SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams.
OutputDataConfig outputDataConfig
Specifies the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.
ResourceConfig resourceConfig
The resources, including the ML compute instances and ML storage volumes, to use for model training.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage
volumes for scratch space. If you want Amazon SageMaker to use the ML storage volume to store the training data,
choose File as the TrainingInputMode in the algorithm specification. For distributed
training algorithms, specify an instance count greater than 1.
VpcConfig vpcConfig
StoppingCondition stoppingCondition
Sets a duration for training. Use this parameter to cap model training costs. To stop a job, Amazon SageMaker
sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms
might use this 120-second window to save the model artifacts.
When Amazon SageMaker terminates a job because the stopping condition has been met, training algorithms provided
by Amazon SageMaker save the intermediate results of the job. This intermediate data is a valid model artifact.
You can use it to create a model using the CreateModel API.
List<E> tags
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
String trainingJobArn
The Amazon Resource Name (ARN) of the training job.
String transformJobName
The name of the transform job. The name must be unique within an AWS Region in an AWS account.
String modelName
The name of the model that you want to use for the transform job. ModelName must be the name of an
existing Amazon SageMaker model within an AWS Region in an AWS account.
Integer maxConcurrentTransforms
The maximum number of parallel requests that can be sent to each instance in a transform job. This is good for
algorithms that implement multiple workers on larger instances . The default value is 1. To allow
Amazon SageMaker to determine the appropriate number for MaxConcurrentTransforms, set the value to
0.
Integer maxPayloadInMB
The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata). The value
in MaxPayloadInMB must be greater or equal to the size of a single record. You can approximate the
size of a record by dividing the size of your dataset by the number of records. Then multiply this value by the
number of records you want in a mini-batch. It is recommended to enter a value slightly larger than this to
ensure the records fit within the maximum payload size. The default value is 6 MB. For an unlimited
payload size, set the value to 0.
String batchStrategy
Determines the number of records included in a single mini-batch. SingleRecord means only one record
is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can
fit within the MaxPayloadInMB limit.
Batch transform will automatically split your input data into whatever payload size is specified if you set
SplitType to Line and BatchStrategy to MultiRecord. There's
no need to split the dataset into smaller files or to use larger payload sizes unless the records in your dataset
are very large.
Map<K,V> environment
The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
TransformInput transformInput
Describes the input source and the way the transform job consumes it.
TransformOutput transformOutput
Describes the results of the transform job.
TransformResources transformResources
Describes the resources, including ML instance types and ML instance count, to use for the transform job.
List<E> tags
An array of key-value pairs. Adding tags is optional. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
String transformJobArn
The Amazon Resource Name (ARN) of the transform job.
S3DataSource s3DataSource
The S3 location of the data source that is associated with a channel.
String endpointConfigName
The name of the endpoint configuration that you want to delete.
String endpointName
The name of the endpoint that you want to delete.
String modelName
The name of the model to delete.
String notebookInstanceLifecycleConfigName
The name of the lifecycle configuration to delete.
String notebookInstanceName
The name of the Amazon SageMaker notebook instance to delete.
String specifiedImage
The image path you specified when you created the model.
String resolvedImage
The specific digest path of the image hosted in this ProductionVariant.
Date resolutionTime
The date and time when the image path for the model resolved to the ResolvedImage
String endpointConfigName
The name of the endpoint configuration.
String endpointConfigName
Name of the Amazon SageMaker endpoint configuration.
String endpointConfigArn
The Amazon Resource Name (ARN) of the endpoint configuration.
List<E> productionVariants
An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
String kmsKeyId
AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
Date creationTime
A timestamp that shows when the endpoint configuration was created.
String endpointName
The name of the endpoint.
String endpointName
Name of the endpoint.
String endpointArn
The Amazon Resource Name (ARN) of the endpoint.
String endpointConfigName
The name of the endpoint configuration associated with this endpoint.
List<E> productionVariants
An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
String endpointStatus
The status of the endpoint.
String failureReason
If the status of the endpoint is Failed, the reason why it failed.
Date creationTime
A timestamp that shows when the endpoint was created.
Date lastModifiedTime
A timestamp that shows when the endpoint was last modified.
String hyperParameterTuningJobName
The name of the tuning job to describe.
String hyperParameterTuningJobName
The name of the tuning job.
String hyperParameterTuningJobArn
The Amazon Resource Name (ARN) of the tuning job.
HyperParameterTuningJobConfig hyperParameterTuningJobConfig
The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
HyperParameterTrainingJobDefinition trainingJobDefinition
The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
String hyperParameterTuningJobStatus
The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
Date creationTime
The date and time that the tuning job started.
Date hyperParameterTuningEndTime
The date and time that the tuning job ended.
Date lastModifiedTime
The date and time that the status of the tuning job was modified.
TrainingJobStatusCounters trainingJobStatusCounters
The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
ObjectiveStatusCounters objectiveStatusCounters
The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
HyperParameterTrainingJobSummary bestTrainingJob
A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
String failureReason
If the tuning job failed, the reason it failed.
String modelName
The name of the model.
String modelName
Name of the Amazon SageMaker model.
ContainerDefinition primaryContainer
The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.
String executionRoleArn
The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
VpcConfig vpcConfig
Date creationTime
A timestamp that shows when the model was created.
String modelArn
The Amazon Resource Name (ARN) of the model.
String notebookInstanceLifecycleConfigName
The name of the lifecycle configuration to describe.
String notebookInstanceLifecycleConfigArn
The Amazon Resource Name (ARN) of the lifecycle configuration.
String notebookInstanceLifecycleConfigName
The name of the lifecycle configuration.
List<E> onCreate
The shell script that runs only once, when you create a notebook instance.
List<E> onStart
The shell script that runs every time you start a notebook instance, including when you create the notebook instance.
Date lastModifiedTime
A timestamp that tells when the lifecycle configuration was last modified.
Date creationTime
A timestamp that tells when the lifecycle configuration was created.
String notebookInstanceName
The name of the notebook instance that you want information about.
String notebookInstanceArn
The Amazon Resource Name (ARN) of the notebook instance.
String notebookInstanceName
Name of the Amazon SageMaker notebook instance.
String notebookInstanceStatus
The status of the notebook instance.
String failureReason
If status is failed, the reason it failed.
String url
The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
String instanceType
The type of ML compute instance running on the notebook instance.
String subnetId
The ID of the VPC subnet.
List<E> securityGroups
The IDs of the VPC security groups.
String roleArn
Amazon Resource Name (ARN) of the IAM role associated with the instance.
String kmsKeyId
AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
String networkInterfaceId
Network interface IDs that Amazon SageMaker created at the time of creating the instance.
Date lastModifiedTime
A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
Date creationTime
A timestamp. Use this parameter to return the time when the notebook instance was created
String notebookInstanceLifecycleConfigName
Returns the name of a notebook instance lifecycle configuration.
For information about notebook instance lifestyle configurations, see notebook-lifecycle-config.
String directInternetAccess
Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, he notebook instance does not have internet access, and cannot connect to Amazon SageMaker training and endpoint services.
For more information, see appendix-notebook-and-internet-access.
String trainingJobName
The name of the training job.
String trainingJobName
Name of the model training job.
String trainingJobArn
The Amazon Resource Name (ARN) of the training job.
String tuningJobArn
The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
ModelArtifacts modelArtifacts
Information about the Amazon S3 location that is configured for storing model artifacts.
String trainingJobStatus
The status of the training job.
For the InProgress status, Amazon SageMaker can return these secondary statuses:
Starting - Preparing for training.
Downloading - Optional stage for algorithms that support File training input mode. It indicates data is being downloaded to ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and model upload is in progress.
For the Stopped training status, Amazon SageMaker can return these secondary statuses:
MaxRuntimeExceeded - Job stopped as a result of maximum allowed runtime exceeded.
String secondaryStatus
Provides granular information about the system state. For more information, see TrainingJobStatus.
Starting - starting the training job.
Downloading - downloading the input data.
Training - model training is in progress.
Uploading - uploading the trained model.
Stopping - stopping the training job.
Stopped - the training job has stopped.
MaxRuntimeExceeded - the training job exceeded the specified max run time and has been stopped.
Completed - the training job has completed.
Failed - the training job has failed. The failure reason is stored in the FailureReason
field of DescribeTrainingJobResponse.
The valid values for SecondaryStatus are subject to change. They primarily provide information on
the progress of the training job.
String failureReason
If the training job failed, the reason it failed.
Map<K,V> hyperParameters
Algorithm-specific parameters.
AlgorithmSpecification algorithmSpecification
Information about the algorithm used for training, and algorithm metadata.
String roleArn
The AWS Identity and Access Management (IAM) role configured for the training job.
List<E> inputDataConfig
An array of Channel objects that describes each data input channel.
OutputDataConfig outputDataConfig
The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
ResourceConfig resourceConfig
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
VpcConfig vpcConfig
StoppingCondition stoppingCondition
The condition under which to stop the training job.
Date creationTime
A timestamp that indicates when the training job was created.
Date trainingStartTime
Indicates the time when the training job starts on training instances. You are billed for the time interval
between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later
than this time. The difference is due to the time it takes to download the training data and to the size of the
training container.
Date trainingEndTime
Indicates the time when the training job ends on training instances. You are billed for the time interval between
the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time
after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job
failure.
Date lastModifiedTime
A timestamp that indicates when the status of the training job was last modified.
List<E> secondaryStatusTransitions
To give an overview of the training job lifecycle, SecondaryStatusTransitions is a log of
time-ordered secondary statuses that a training job has transitioned.
String transformJobName
The name of the transform job that you want to view details of.
String transformJobName
The name of the transform job.
String transformJobArn
The Amazon Resource Name (ARN) of the transform job.
String transformJobStatus
The status of the transform job. If the transform job failed, the reason is returned in the
FailureReason field.
String failureReason
If the transform job failed, the reason that it failed.
String modelName
The name of the model used in the transform job.
Integer maxConcurrentTransforms
The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.
Integer maxPayloadInMB
The maximum payload size , in MB used in the transform job.
String batchStrategy
SingleRecord means only one record was used per a batch. MultiRecord means batches contained as many
records that could possibly fit within the MaxPayloadInMB limit.
Map<K,V> environment
TransformInput transformInput
Describes the dataset to be transformed and the Amazon S3 location where it is stored.
TransformOutput transformOutput
Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
TransformResources transformResources
Describes the resources, including ML instance types and ML instance count, to use for the transform job.
Date creationTime
A timestamp that shows when the transform Job was created.
Date transformStartTime
Indicates when the transform job starts on ML instances. You are billed for the time interval between this time
and the value of TransformEndTime.
Date transformEndTime
Indicates when the transform job is Completed, Stopped, or Failed. You are
billed for the time interval between this time and the value of TransformStartTime.
String endpointName
The name of the endpoint.
String endpointArn
The Amazon Resource Name (ARN) of the endpoint.
Date creationTime
A timestamp that shows when the endpoint was created.
Date lastModifiedTime
A timestamp that shows when the endpoint was last modified.
String endpointStatus
The status of the endpoint.
String trainingImage
The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see sagemaker-algo-docker-registry-paths.
String trainingInputMode
The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container.
If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information.
For more information about input modes, see Algorithms.
List<E> metricDefinitions
An array of MetricDefinition objects that specify the metrics that the algorithm emits.
Map<K,V> staticHyperParameters
Specifies the values of hyperparameters that do not change for the tuning job.
HyperParameterAlgorithmSpecification algorithmSpecification
The HyperParameterAlgorithmSpecification object that specifies the algorithm to use for the training jobs that the tuning job launches.
String roleArn
The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.
List<E> inputDataConfig
An array of Channel objects that specify the input for the training jobs that the tuning job launches.
VpcConfig vpcConfig
OutputDataConfig outputDataConfig
Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.
ResourceConfig resourceConfig
The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.
Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes
for scratch space. If you want Amazon SageMaker to use the storage volume to store the training data, choose
File as the TrainingInputMode in the algorithm specification. For distributed training
algorithms, specify an instance count greater than 1.
StoppingCondition stoppingCondition
Sets a maximum duration for the training jobs that the tuning job launches. Use this parameter to limit model training costs.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This delays job termination
for 120 seconds. Algorithms might use this 120-second window to save the model artifacts.
When Amazon SageMaker terminates a job because the stopping condition has been met, training algorithms provided by Amazon SageMaker save the intermediate results of the job.
String trainingJobName
The name of the training job.
String trainingJobArn
The Amazon Resource Name (ARN) of the training job.
Date creationTime
The date and time that the training job was created.
Date trainingStartTime
The date and time that the training job started.
Date trainingEndTime
The date and time that the training job ended.
String trainingJobStatus
The status of the training job.
Map<K,V> tunedHyperParameters
A list of the hyperparameters for which you specified ranges to search.
String failureReason
The reason that the training job failed.
FinalHyperParameterTuningJobObjectiveMetric finalHyperParameterTuningJobObjectiveMetric
The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
String objectiveStatus
The status of the objective metric for the training job:
Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
Pending: The training job is in progress and evaluation of its final objective metric is pending.
Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.
String strategy
Specifies the search strategy for hyperparameters. Currently, the only valid value is Bayesian.
HyperParameterTuningJobObjective hyperParameterTuningJobObjective
The HyperParameterTuningJobObjective object that specifies the objective metric for this tuning job.
ResourceLimits resourceLimits
The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs for this tuning job.
ParameterRanges parameterRanges
The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches.
String hyperParameterTuningJobName
The name of the tuning job.
String hyperParameterTuningJobArn
The Amazon Resource Name (ARN) of the tuning job.
String hyperParameterTuningJobStatus
The status of the tuning job.
String strategy
Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration. Currently, the only valid value is Bayesian.
Date creationTime
The date and time that the tuning job was created.
Date hyperParameterTuningEndTime
The date and time that the tuning job ended.
Date lastModifiedTime
The date and time that the tuning job was modified.
TrainingJobStatusCounters trainingJobStatusCounters
The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.
ObjectiveStatusCounters objectiveStatusCounters
The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
ResourceLimits resourceLimits
The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
String sortBy
The field to sort results by. The default is CreationTime.
String sortOrder
The sort order for results. The default is Ascending.
String nextToken
If the result of the previous ListEndpointConfig request was truncated, the response includes a
NextToken. To retrieve the next set of endpoint configurations, use the token in the next request.
Integer maxResults
The maximum number of training jobs to return in the response.
String nameContains
A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.
Date creationTimeBefore
A filter that returns only endpoint configurations created before the specified time (timestamp).
Date creationTimeAfter
A filter that returns only endpoint configurations created after the specified time (timestamp).
String sortBy
Sorts the list of results. The default is CreationTime.
String sortOrder
The sort order for results. The default is Ascending.
String nextToken
If the result of a ListEndpoints request was truncated, the response includes a
NextToken. To retrieve the next set of endpoints, use the token in the next request.
Integer maxResults
The maximum number of endpoints to return in the response.
String nameContains
A string in endpoint names. This filter returns only endpoints whose name contains the specified string.
Date creationTimeBefore
A filter that returns only endpoints that were created before the specified time (timestamp).
Date creationTimeAfter
A filter that returns only endpoints that were created after the specified time (timestamp).
Date lastModifiedTimeBefore
A filter that returns only endpoints that were modified before the specified timestamp.
Date lastModifiedTimeAfter
A filter that returns only endpoints that were modified after the specified timestamp.
String statusEquals
A filter that returns only endpoints with the specified status.
String nextToken
If the result of the previous ListHyperParameterTuningJobs request was truncated, the response
includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.
Integer maxResults
The maximum number of tuning jobs to return. The default value is 10.
String sortBy
The field to sort results by. The default is Name.
String sortOrder
The sort order for results. The default is Ascending.
String nameContains
A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
Date creationTimeAfter
A filter that returns only tuning jobs that were created after the specified time.
Date creationTimeBefore
A filter that returns only tuning jobs that were created before the specified time.
Date lastModifiedTimeAfter
A filter that returns only tuning jobs that were modified after the specified time.
Date lastModifiedTimeBefore
A filter that returns only tuning jobs that were modified before the specified time.
String statusEquals
A filter that returns only tuning jobs with the specified status.
List<E> hyperParameterTuningJobSummaries
A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the
ListHyperParameterTuningJobs request returned.
String nextToken
If the result of this ListHyperParameterTuningJobs request was truncated, the response includes a
NextToken. To retrieve the next set of tuning jobs, use the token in the next request.
String sortBy
Sorts the list of results. The default is CreationTime.
String sortOrder
The sort order for results. The default is Ascending.
String nextToken
If the response to a previous ListModels request was truncated, the response includes a
NextToken. To retrieve the next set of models, use the token in the next request.
Integer maxResults
The maximum number of models to return in the response.
String nameContains
A string in the training job name. This filter returns only models in the training job whose name contains the specified string.
Date creationTimeBefore
A filter that returns only models created before the specified time (timestamp).
Date creationTimeAfter
A filter that returns only models created after the specified time (timestamp).
String nextToken
If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, the response includes
a NextToken. To get the next set of lifecycle configurations, use the token in the next request.
Integer maxResults
The maximum number of lifecycle configurations to return in the response.
String sortBy
Sorts the list of results. The default is CreationTime.
String sortOrder
The sort order for results.
String nameContains
A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.
Date creationTimeBefore
A filter that returns only lifecycle configurations that were created before the specified time (timestamp).
Date creationTimeAfter
A filter that returns only lifecycle configurations that were created after the specified time (timestamp).
Date lastModifiedTimeBefore
A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).
Date lastModifiedTimeAfter
A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).
String nextToken
If the response is truncated, Amazon SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.
List<E> notebookInstanceLifecycleConfigs
An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.
String nextToken
If the previous call to the ListNotebookInstances is truncated, the response includes a
NextToken. You can use this token in your subsequent ListNotebookInstances request to
fetch the next set of notebook instances.
You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.
Integer maxResults
The maximum number of notebook instances to return.
String sortBy
The field to sort results by. The default is Name.
String sortOrder
The sort order for results.
String nameContains
A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.
Date creationTimeBefore
A filter that returns only notebook instances that were created before the specified time (timestamp).
Date creationTimeAfter
A filter that returns only notebook instances that were created after the specified time (timestamp).
Date lastModifiedTimeBefore
A filter that returns only notebook instances that were modified before the specified time (timestamp).
Date lastModifiedTimeAfter
A filter that returns only notebook instances that were modified after the specified time (timestamp).
String statusEquals
A filter that returns only notebook instances with the specified status.
String notebookInstanceLifecycleConfigNameContains
A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.
String nextToken
If the response to the previous ListNotebookInstances request was truncated, Amazon SageMaker
returns this token. To retrieve the next set of notebook instances, use the token in the next request.
List<E> notebookInstances
An array of NotebookInstanceSummary objects, one for each notebook instance.
String resourceArn
The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
String nextToken
If the response to the previous ListTags request is truncated, Amazon SageMaker returns this token.
To retrieve the next set of tags, use it in the subsequent request.
Integer maxResults
Maximum number of tags to return.
String hyperParameterTuningJobName
The name of the tuning job whose training jobs you want to list.
String nextToken
If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the
response includes a NextToken. To retrieve the next set of training jobs, use the token in the next
request.
Integer maxResults
The maximum number of training jobs to return. The default value is 10.
String statusEquals
A filter that returns only training jobs with the specified status.
String sortBy
The field to sort results by. The default is Name.
If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an
objective metric are not listed.
String sortOrder
The sort order for results. The default is Ascending.
List<E> trainingJobSummaries
A list of TrainingJobSummary objects that describe the training jobs that the
ListTrainingJobsForHyperParameterTuningJob request returned.
String nextToken
If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response
includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
String nextToken
If the result of the previous ListTrainingJobs request was truncated, the response includes a
NextToken. To retrieve the next set of training jobs, use the token in the next request.
Integer maxResults
The maximum number of training jobs to return in the response.
Date creationTimeAfter
A filter that returns only training jobs created after the specified time (timestamp).
Date creationTimeBefore
A filter that returns only training jobs created before the specified time (timestamp).
Date lastModifiedTimeAfter
A filter that returns only training jobs modified after the specified time (timestamp).
Date lastModifiedTimeBefore
A filter that returns only training jobs modified before the specified time (timestamp).
String nameContains
A string in the training job name. This filter returns only training jobs whose name contains the specified string.
String statusEquals
A filter that retrieves only training jobs with a specific status.
String sortBy
The field to sort results by. The default is CreationTime.
String sortOrder
The sort order for results. The default is Ascending.
Date creationTimeAfter
A filter that returns only transform jobs created after the specified time.
Date creationTimeBefore
A filter that returns only transform jobs created before the specified time.
Date lastModifiedTimeAfter
A filter that returns only transform jobs modified after the specified time.
Date lastModifiedTimeBefore
A filter that returns only transform jobs modified before the specified time.
String nameContains
A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.
String statusEquals
A filter that retrieves only transform jobs with a specific status.
String sortBy
The field to sort results by. The default is CreationTime.
String sortOrder
The sort order for results. The default is Descending.
String nextToken
If the result of the previous ListTransformJobs request was truncated, the response includes a
NextToken. To retrieve the next set of transform jobs, use the token in the next request.
Integer maxResults
The maximum number of transform jobs to return in the response. The default value is 10.
String name
The name of the metric.
String regex
A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see automatic-model-tuning-define-metrics.
String s3ModelArtifacts
The path of the S3 object that contains the model artifacts. For example,
s3://bucket-name/keynameprefix/model.tar.gz.
String notebookInstanceLifecycleConfigName
The name of the lifecycle configuration.
String notebookInstanceLifecycleConfigArn
The Amazon Resource Name (ARN) of the lifecycle configuration.
Date creationTime
A timestamp that tells when the lifecycle configuration was created.
Date lastModifiedTime
A timestamp that tells when the lifecycle configuration was last modified.
String content
A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.
String notebookInstanceName
The name of the notebook instance that you want a summary for.
String notebookInstanceArn
The Amazon Resource Name (ARN) of the notebook instance.
String notebookInstanceStatus
The status of the notebook instance.
String url
The URL that you use to connect to the Jupyter instance running in your notebook instance.
String instanceType
The type of ML compute instance that the notebook instance is running on.
Date creationTime
A timestamp that shows when the notebook instance was created.
Date lastModifiedTime
A timestamp that shows when the notebook instance was last modified.
String notebookInstanceLifecycleConfigName
The name of a notebook instance lifecycle configuration associated with this notebook instance.
For information about notebook instance lifestyle configurations, see notebook-lifecycle-config.
Integer succeeded
The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
Integer pending
The number of training jobs that are in progress and pending evaluation of their final objective metric.
Integer failed
The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.
String kmsKeyId
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.
If you don't provide the KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in Amazon Simple Storage Service developer guide.
The KMS key policy must grant permission to the IAM role you specify in your CreateTrainingJob
request. Using Key Policies in
AWS KMS in the AWS Key Management Service Developer Guide.
String s3OutputPath
Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example,
s3://bucket-name/key-name-prefix.
List<E> integerParameterRanges
The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
List<E> continuousParameterRanges
The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
List<E> categoricalParameterRanges
The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
String variantName
The name of the production variant.
String modelName
The name of the model that you want to host. This is the name that you specified when creating the model.
Integer initialInstanceCount
Number of instances to launch initially.
String instanceType
The ML compute instance type.
Float initialVariantWeight
Determines initial traffic distribution among all of the models that you specify in the endpoint configuration.
The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of
all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.
String variantName
The name of the variant.
List<E> deployedImages
An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the
inference images deployed on instances of this ProductionVariant.
Float currentWeight
The weight associated with the variant.
Float desiredWeight
The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.
Integer currentInstanceCount
The number of instances associated with the variant.
Integer desiredInstanceCount
The number of instances requested in the UpdateEndpointWeightsAndCapacities request.
String instanceType
The ML compute instance type.
Integer instanceCount
The number of ML compute instances to use. For distributed training, provide a value greater than 1.
Integer volumeSizeInGB
The size of the ML storage volume that you want to provision.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML
storage volume for scratch space. If you want to store the training data in the ML storage volume, choose
File as the TrainingInputMode in the algorithm specification.
You must specify sufficient ML storage for your scenario.
Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
String volumeKmsKeyId
The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.
String s3DataType
If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all
objects with the specified key name prefix for model training.
If you choose ManifestFile, S3Uri identifies an object that is a manifest file
containing a list of object keys that you want Amazon SageMaker to use for model training.
String s3Uri
Depending on the value specified for the S3DataType, identifies either a key name prefix or a
manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix.
A manifest might look like this: s3://bucketname/example.manifest
The manifest is an S3 object which is a JSON file with the following format:
[
{"prefix": "s3://customer_bucket/some/prefix/"},
"relative/path/to/custdata-1",
"relative/path/custdata-2",
...
]
The preceding JSON matches the following s3Uris:
s3://customer_bucket/some/prefix/relative/path/to/custdata-1
s3://customer_bucket/some/prefix/relative/path/custdata-1
...
The complete set of s3uris in this manifest constitutes the input data for the channel for this
datasource. The object that each s3uris points to must readable by the IAM role that Amazon
SageMaker uses to perform tasks on your behalf.
String s3DataDistributionType
If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for
model training, specify FullyReplicated.
If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model
training, specify ShardedByS3Key. If there are n ML compute instances launched for a training
job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on
each machine uses only the subset of training data.
Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both FILE and PIPE modes. Keep this in mind when developing algorithms.
In distributed training, where you use multiple ML compute EC2 instances, you might choose
ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when
TrainingInputMode is set to File), this copies 1/n of the number of objects.
String status
Provides granular information about the system state. For more information, see SecondaryStatus
under the DescribeTrainingJob response elements.
Date startTime
A timestamp that shows when the training job has entered this secondary status.
Date endTime
A timestamp that shows when the secondary status has ended and the job has transitioned into another secondary
status. The EndTime timestamp is also set after the training job has ended.
String statusMessage
Shows a brief description and other information about the secondary status. For example, the
LaunchingMLInstances secondary status could show a status message of
"Insufficent capacity error while launching instances".
String notebookInstanceName
The name of the notebook instance to start.
String hyperParameterTuningJobName
The name of the tuning job to stop.
String notebookInstanceName
The name of the notebook instance to terminate.
Integer maxRuntimeInSeconds
The maximum length of time, in seconds, that the training job can run. If model training does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. Maximum value is 5 days.
String trainingJobName
The name of the training job to stop.
String transformJobName
The name of the transform job to stop.
Integer completed
The number of completed training jobs launched by a hyperparameter tuning job.
Integer inProgress
The number of in-progress training jobs launched by a hyperparameter tuning job.
Integer retryableError
The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.
Integer nonRetryableError
The number of training jobs that failed and can't be retried. A failed training job can't be retried if it failed because a client error occurred.
Integer stopped
The number of training jobs launched by a hyperparameter tuning job that were manually stopped.
String trainingJobName
The name of the training job that you want a summary for.
String trainingJobArn
The Amazon Resource Name (ARN) of the training job.
Date creationTime
A timestamp that shows when the training job was created.
Date trainingEndTime
A timestamp that shows when the training job ended. This field is set only if the training job has one of the
terminal statuses (Completed, Failed, or Stopped).
Date lastModifiedTime
Timestamp when the training job was last modified.
String trainingJobStatus
The status of the training job.
TransformS3DataSource s3DataSource
The S3 location of the data source that is associated with a channel.
TransformDataSource dataSource
Describes the location of the channel data, meaning the S3 location of the input data that the model can consume.
String contentType
The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.
String compressionType
Compressing data helps save on storage space. If your transform data is compressed, specify the compression
type.and Amazon SageMaker will automatically decompress the data for the transform job accordingly. The default
value is None.
String splitType
The method to use to split the transform job's data into smaller batches. The default value is None.
If you don't want to split the data, specify None. If you want to split records on a newline
character boundary, specify Line. To split records according to the RecordIO format, specify
RecordIO.
Amazon SageMaker will send maximum number of records per batch in each request up to the MaxPayloadInMB limit. For more information, see RecordIO data format.
For information about the RecordIO format, see Data Format.
String transformJobName
The name of the transform job.
String transformJobArn
The Amazon Resource Name (ARN) of the transform job.
Date creationTime
A timestamp that shows when the transform Job was created.
Date transformEndTime
Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.
Date lastModifiedTime
Indicates when the transform job was last modified.
String transformJobStatus
The status of the transform job.
String failureReason
If the transform job failed, the reason it failed.
String s3OutputPath
The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example,
s3://bucket-name/key-name-prefix.
For every S3 object used as input for the transform job, the transformed data is stored in a corresponding
subfolder in the location under the output prefix. For example, the input data
s3://bucket-name/input-name-prefix/dataset01/data.csv will have the transformed data stored at
s3://bucket-name/key-name-prefix/dataset01/, based on the original name, as a series of .part files
(.part0001, part0002, etc).
String accept
The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.
String assembleWith
Defines how to assemble the results of the transform job as a single S3 object. You should select a format that
is most convenient to you. To concatenate the results in binary format, specify None. To add a
newline character at the end of every transformed record, specify Line. To assemble the output in
RecordIO format, specify RecordIO. The default value is None.
For information about the RecordIO format, see Data Format.
String kmsKeyId
The AWS Key Management Service (AWS KMS) key for Amazon S3 server-side encryption that Amazon SageMaker uses to encrypt the transformed data.
If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateTramsformJob
request. For more information, see Using Key Policies in AWS KMS
in the AWS Key Management Service Developer Guide.
String instanceType
The ML compute instance type for the transform job. For using built-in algorithms to transform moderately sized
datasets, ml.m4.xlarge or ml.m5.large should suffice. There is no default value for
InstanceType.
Integer instanceCount
The number of ML compute instances to use in the transform job. For distributed transform, provide a value
greater than 1. The default value is 1.
String volumeKmsKeyId
The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the batch transform job.
String s3DataType
If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all
objects with the specified key name prefix for batch transform.
If you choose ManifestFile, S3Uri identifies an object that is a manifest file
containing a list of object keys that you want Amazon SageMaker to use for batch transform.
String s3Uri
Depending on the value specified for the S3DataType, identifies either a key name prefix or a
manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix.
A manifest might look like this: s3://bucketname/example.manifest
The manifest is an S3 object which is a JSON file with the following format:
[
{"prefix": "s3://customer_bucket/some/prefix/"},
"relative/path/to/custdata-1",
"relative/path/custdata-2",
...
]
The preceding JSON matches the following S3Uris:
s3://customer_bucket/some/prefix/relative/path/to/custdata-1
s3://customer_bucket/some/prefix/relative/path/custdata-1
...
The complete set of S3Uris in this manifest constitutes the input data for the channel for this
datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon
SageMaker uses to perform tasks on your behalf.
String endpointArn
The Amazon Resource Name (ARN) of the endpoint.
String endpointArn
The Amazon Resource Name (ARN) of the updated endpoint.
String notebookInstanceLifecycleConfigName
The name of the lifecycle configuration.
List<E> onCreate
The shell script that runs only once, when you create a notebook instance
List<E> onStart
The shell script that runs every time you start a notebook instance, including when you create the notebook instance.
String notebookInstanceName
The name of the notebook instance to update.
String instanceType
The Amazon ML compute instance type.
String roleArn
The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the notebook instance. For more information, see Amazon SageMaker Roles.
To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole
permission.
String lifecycleConfigName
The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see notebook-lifecycle-config.
Boolean disassociateLifecycleConfig
Set to true to remove the notebook instance lifecycle configuration currently associated with the
notebook instance.
Copyright © 2018. All rights reserved.