software.amazon.awscdk.services.sagemaker

Interface CfnModelPackage.TransformOutputProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelPackage.TransformOutputProperty.Jsii$Proxy

Enclosing class:

CfnModelPackage

@Stability(value=Stable)
public static interface CfnModelPackage.TransformOutputProperty
extends software.amazon.jsii.JsiiSerializable

Describes the results of a transform job.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 TransformOutputProperty transformOutputProperty = TransformOutputProperty.builder()
         .s3OutputPath("s3OutputPath")
         // the properties below are optional
         .accept("accept")
         .assembleWith("assembleWith")
         .kmsKeyId("kmsKeyId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnModelPackage.TransformOutputProperty.Builder A builder for CfnModelPackage.TransformOutputProperty
static class	CfnModelPackage.TransformOutputProperty.Jsii$Proxy An implementation for CfnModelPackage.TransformOutputProperty

Method Summary

Modifier and Type	Method and Description
static CfnModelPackage.TransformOutputProperty.Builder	builder()
default String	getAccept() The MIME type used to specify the output data.
default String	getAssembleWith() Defines how to assemble the results of the transform job as a single S3 object.
default String	getKmsKeyId() 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.
String	getS3OutputPath() The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getS3OutputPath

@Stability(value=Stable)
 @NotNull
String getS3OutputPath()

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, batch transform stores the transformed data with an . out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv , batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out . Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an . out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.

getAccept

@Stability(value=Stable)
 @Nullable
default String getAccept()

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.

getAssembleWith

@Stability(value=Stable)
 @Nullable
default String getAssembleWith()

Defines how to assemble the results of the transform job as a single S3 object.

Choose 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 .

getKmsKeyId

@Stability(value=Stable)
 @Nullable
default String getKmsKeyId()

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.

The KmsKeyId can be any of the following formats:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

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 CreateModel request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide .

builder

@Stability(value=Stable)
static CfnModelPackage.TransformOutputProperty.Builder builder()

Returns:

a CfnModelPackage.TransformOutputProperty.Builder of CfnModelPackage.TransformOutputProperty