Class CfnModelPackagePropsMixin.TransformOutputProperty

Describes the results of a transform job.

Inheritance

object

CfnModelPackagePropsMixin.TransformOutputProperty

Implements

CfnModelPackagePropsMixin.ITransformOutputProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnModelPackagePropsMixin.TransformOutputProperty : CfnModelPackagePropsMixin.ITransformOutputProperty

Syntax (vb)

Public Class CfnModelPackagePropsMixin.TransformOutputProperty Implements CfnModelPackagePropsMixin.ITransformOutputProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformoutput.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins;

             var transformOutputProperty = new TransformOutputProperty {
                 Accept = "accept",
                 AssembleWith = "assembleWith",
                 KmsKeyId = "kmsKeyId",
                 S3OutputPath = "s3OutputPath"
             };

Synopsis

Constructors

TransformOutputProperty()

Describes the results of a transform job.

Properties

Accept	The MIME type used to specify the output data.
AssembleWith	Defines how to assemble the results of the transform job as a single S3 object.
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.
S3OutputPath	The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job.

Constructors

TransformOutputProperty()

Describes the results of a transform job.

public TransformOutputProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformoutput.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins;

             var transformOutputProperty = new TransformOutputProperty {
                 Accept = "accept",
                 AssembleWith = "assembleWith",
                 KmsKeyId = "kmsKeyId",
                 S3OutputPath = "s3OutputPath"
             };

Properties

Accept

The MIME type used to specify the output data.

public string? Accept { get; set; }

Property Value

string

Remarks

Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformoutput.html#cfn-sagemaker-modelpackage-transformoutput-accept

AssembleWith

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

public string? AssembleWith { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformoutput.html#cfn-sagemaker-modelpackage-transformoutput-assemblewith

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.

public string? KmsKeyId { get; set; }

Property Value

string

Remarks

The KmsKeyId can be any of the following formats:

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformoutput.html#cfn-sagemaker-modelpackage-transformoutput-kmskeyid

S3OutputPath

The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job.

public string? S3OutputPath { get; set; }

Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformoutput.html#cfn-sagemaker-modelpackage-transformoutput-s3outputpath

Implements

CfnModelPackagePropsMixin.ITransformOutputProperty