OutputDataConfig
Provides information about how to store model training results (model artifacts).
Contents
- S3OutputPath
-
Identifies the S3 path where you want SageMaker to store the model artifacts. For example,
s3://bucket-name/key-name-prefix
.Type: String
Length Constraints: Maximum length of 1024.
Pattern:
^(https|s3)://([^/]+)/?(.*)$
Required: Yes
- CompressionType
-
The model output compression type. Select
None
to output an uncompressed model, recommended for large model outputs. Defaults to gzip.Type: String
Valid Values:
GZIP | NONE
Required: No
- KmsKeyId
-
The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. 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:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
-
// KMS Key Alias
"alias/ExampleAlias"
-
// Amazon Resource Name (ARN) of a KMS Key Alias
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call
kms:Encrypt
. If you don't provide a KMS key ID, 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. If the output data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3 managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One ZoneThe KMS key policy must grant permission to the IAM role that you specify in your
CreateTrainingJob
,CreateTransformJob
, orCreateHyperParameterTuningJob
requests. For more information, see Using Key Policies in Amazon KMS in the Amazon Key Management Service Developer Guide.Type: String
Length Constraints: Maximum length of 2048.
Pattern:
^[a-zA-Z0-9:/_-]*$
Required: No
-
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: