Class: AWSCDK::Sagemaker::CfnModelPackage::TransformOutputProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_model_package.rb

Overview

Describes the results of a transform job.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(s3_output_path:, accept: nil, assemble_with: nil, kms_key_id: nil) ⇒ TransformOutputProperty

Returns a new instance of TransformOutputProperty.

Parameters:

  • s3_output_path (String) —

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

  • accept (String, nil) (defaults to: nil) —

    The MIME type used to specify the output data.

  • assemble_with (String, nil) (defaults to: nil) —

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

  • kms_key_id (String, nil) (defaults to: nil) —

    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.



2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'sagemaker/cfn_model_package.rb', line 2613

def initialize(s3_output_path:, accept: nil, assemble_with: nil, kms_key_id: nil)
  @s3_output_path = s3_output_path
  Jsii::Type.check_type(@s3_output_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3OutputPath")
  @accept = accept
  Jsii::Type.check_type(@accept, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accept") unless @accept.nil?
  @assemble_with = assemble_with
  Jsii::Type.check_type(@assemble_with, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "assembleWith") unless @assemble_with.nil?
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless @kms_key_id.nil?
end

Instance Attribute Details

#accept ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



2639
2640
2641
 
# File 'sagemaker/cfn_model_package.rb', line 2639

def accept
  @accept
end

#assemble_with ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



2646
2647
2648
 
# File 'sagemaker/cfn_model_package.rb', line 2646

def assemble_with
  @assemble_with
end

#kms_key_id ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



2662
2663
2664
 
# File 'sagemaker/cfn_model_package.rb', line 2662

def kms_key_id
  @kms_key_id
end

#s3_output_path ⇒ String (readonly)

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.

Returns:

  • (String)

See Also:



2632
2633
2634
 
# File 'sagemaker/cfn_model_package.rb', line 2632

def s3_output_path
  @s3_output_path
end

Class Method Details

.jsii_properties ⇒ Object 



2664
2665
2666
2667
2668
2669
2670
2671
 
# File 'sagemaker/cfn_model_package.rb', line 2664

def self.jsii_properties
  {
    :s3_output_path => "s3OutputPath",
    :accept => "accept",
    :assemble_with => "assembleWith",
    :kms_key_id => "kmsKeyId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
 
# File 'sagemaker/cfn_model_package.rb', line 2673

def to_jsii
  result = {}
  result.merge!({
    "s3OutputPath" => @s3_output_path,
    "accept" => @accept,
    "assembleWith" => @assemble_with,
    "kmsKeyId" => @kms_key_id,
  })
  result.compact
end