Skip to content

Commit 70ce8fa

Browse files
authored
documentation: add security note for the estimator hyperparameter arg (#3622)
1 parent 58fe72a commit 70ce8fa

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

src/sagemaker/estimator.py

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -423,6 +423,13 @@ def __init__(
423423
hyperparameters (dict[str, str] or dict[str, PipelineVariable]):
424424
A dictionary containing the hyperparameters to
425425
initialize this estimator with. (Default: None).
426+
427+
.. caution::
428+
You must not include any security-sensitive information, such as
429+
account access IDs, secrets, and tokens, in the dictionary for configuring
430+
hyperparameters. SageMaker rejects the training job request and returns an
431+
validation error for detected credentials, if such user input is found.
432+
426433
container_log_level (int or PipelineVariable): The log level to use within the container
427434
(default: logging.INFO). Valid values are defined in the Python
428435
logging module.
@@ -2462,6 +2469,13 @@ def __init__(
24622469
using the default AWS configuration chain.
24632470
hyperparameters (dict[str, str] or dict[str, PipelineVariable]):
24642471
Dictionary containing the hyperparameters to initialize this estimator with.
2472+
2473+
.. caution::
2474+
You must not include any security-sensitive information, such as
2475+
account access IDs, secrets, and tokens, in the dictionary for configuring
2476+
hyperparameters. SageMaker rejects the training job request and returns an
2477+
validation error for detected credentials, if such user input is found.
2478+
24652479
tags (list[dict[str, str] or list[dict[str, PipelineVariable]]): List of tags for
24662480
labeling a training job. For more, see
24672481
https://docs.aws.amazon.com/sagemaker/latest/dg/API_Tag.html.
@@ -2939,6 +2953,13 @@ def __init__(
29392953
SageMaker. For convenience, this accepts other types for keys
29402954
and values, but ``str()`` will be called to convert them before
29412955
training.
2956+
2957+
.. caution::
2958+
You must not include any security-sensitive information, such as
2959+
account access IDs, secrets, and tokens, in the dictionary for configuring
2960+
hyperparameters. SageMaker rejects the training job request and returns an
2961+
validation error for detected credentials, if such user input is found.
2962+
29422963
container_log_level (int or PipelineVariable): Log level to use within the container
29432964
(default: logging.INFO). Valid values are defined in the Python
29442965
logging module.

0 commit comments

Comments
 (0)