OutputDataConfig - Amazon SageMaker (original) (raw)

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: Minimum length of 0. 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 AWS Key Management Service (AWS KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. TheKmsKeyId 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 Zone

The KMS key policy must grant permission to the IAM role that you specify in yourCreateTrainingJob, CreateTransformJob, orCreateHyperParameterTuningJob requests. For more information, seeUsing Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

Type: String

Length Constraints: Minimum length of 0. 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 AWS SDKs, see the following:

• AWS SDK for C++
• AWS SDK for Java V2
• AWS SDK for Ruby V3

OutputConfig

OutputParameter

Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.