AWS SDK for C++  1.9.46
AWS SDK for C++
Public Member Functions | List of all members
Aws::SageMaker::Model::TransformOutput Class Reference

#include <TransformOutput.h>

Public Member Functions

 TransformOutput ()
 
 TransformOutput (Aws::Utils::Json::JsonView jsonValue)
 
TransformOutputoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetS3OutputPath () const
 
bool S3OutputPathHasBeenSet () const
 
void SetS3OutputPath (const Aws::String &value)
 
void SetS3OutputPath (Aws::String &&value)
 
void SetS3OutputPath (const char *value)
 
TransformOutputWithS3OutputPath (const Aws::String &value)
 
TransformOutputWithS3OutputPath (Aws::String &&value)
 
TransformOutputWithS3OutputPath (const char *value)
 
const Aws::StringGetAccept () const
 
bool AcceptHasBeenSet () const
 
void SetAccept (const Aws::String &value)
 
void SetAccept (Aws::String &&value)
 
void SetAccept (const char *value)
 
TransformOutputWithAccept (const Aws::String &value)
 
TransformOutputWithAccept (Aws::String &&value)
 
TransformOutputWithAccept (const char *value)
 
const AssemblyTypeGetAssembleWith () const
 
bool AssembleWithHasBeenSet () const
 
void SetAssembleWith (const AssemblyType &value)
 
void SetAssembleWith (AssemblyType &&value)
 
TransformOutputWithAssembleWith (const AssemblyType &value)
 
TransformOutputWithAssembleWith (AssemblyType &&value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
TransformOutputWithKmsKeyId (const Aws::String &value)
 
TransformOutputWithKmsKeyId (Aws::String &&value)
 
TransformOutputWithKmsKeyId (const char *value)
 

Detailed Description

Describes the results of a transform job.

See Also:

AWS API Reference

Definition at line 32 of file TransformOutput.h.

Constructor & Destructor Documentation

◆ TransformOutput() [1/2]

Aws::SageMaker::Model::TransformOutput::TransformOutput ( )

◆ TransformOutput() [2/2]

Aws::SageMaker::Model::TransformOutput::TransformOutput ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AcceptHasBeenSet()

bool Aws::SageMaker::Model::TransformOutput::AcceptHasBeenSet ( ) const
inline

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.

Definition at line 212 of file TransformOutput.h.

◆ AssembleWithHasBeenSet()

bool Aws::SageMaker::Model::TransformOutput::AssembleWithHasBeenSet ( ) const
inline

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.

Definition at line 265 of file TransformOutput.h.

◆ GetAccept()

const Aws::String& Aws::SageMaker::Model::TransformOutput::GetAccept ( ) const
inline

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.

Definition at line 206 of file TransformOutput.h.

◆ GetAssembleWith()

const AssemblyType& Aws::SageMaker::Model::TransformOutput::GetAssembleWith ( ) const
inline

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.

Definition at line 257 of file TransformOutput.h.

◆ GetKmsKeyId()

const Aws::String& Aws::SageMaker::Model::TransformOutput::GetKmsKeyId ( ) const
inline

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.

Definition at line 320 of file TransformOutput.h.

◆ GetS3OutputPath()

const Aws::String& Aws::SageMaker::Model::TransformOutput::GetS3OutputPath ( ) const
inline

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.

Definition at line 59 of file TransformOutput.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SageMaker::Model::TransformOutput::Jsonize ( ) const

◆ KmsKeyIdHasBeenSet()

bool Aws::SageMaker::Model::TransformOutput::KmsKeyIdHasBeenSet ( ) const
inline

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.

Definition at line 342 of file TransformOutput.h.

◆ operator=()

TransformOutput& Aws::SageMaker::Model::TransformOutput::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ S3OutputPathHasBeenSet()

bool Aws::SageMaker::Model::TransformOutput::S3OutputPathHasBeenSet ( ) const
inline

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.

Definition at line 79 of file TransformOutput.h.

◆ SetAccept() [1/3]

void Aws::SageMaker::Model::TransformOutput::SetAccept ( Aws::String &&  value)
inline

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.

Definition at line 224 of file TransformOutput.h.

◆ SetAccept() [2/3]

void Aws::SageMaker::Model::TransformOutput::SetAccept ( const Aws::String value)
inline

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.

Definition at line 218 of file TransformOutput.h.

◆ SetAccept() [3/3]

void Aws::SageMaker::Model::TransformOutput::SetAccept ( const char *  value)
inline

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.

Definition at line 230 of file TransformOutput.h.

◆ SetAssembleWith() [1/2]

void Aws::SageMaker::Model::TransformOutput::SetAssembleWith ( AssemblyType &&  value)
inline

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.

Definition at line 281 of file TransformOutput.h.

◆ SetAssembleWith() [2/2]

void Aws::SageMaker::Model::TransformOutput::SetAssembleWith ( const AssemblyType value)
inline

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.

Definition at line 273 of file TransformOutput.h.

◆ SetKmsKeyId() [1/3]

void Aws::SageMaker::Model::TransformOutput::SetKmsKeyId ( Aws::String &&  value)
inline

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.

Definition at line 386 of file TransformOutput.h.

◆ SetKmsKeyId() [2/3]

void Aws::SageMaker::Model::TransformOutput::SetKmsKeyId ( const Aws::String value)
inline

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.

Definition at line 364 of file TransformOutput.h.

◆ SetKmsKeyId() [3/3]

void Aws::SageMaker::Model::TransformOutput::SetKmsKeyId ( const char *  value)
inline

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.

Definition at line 408 of file TransformOutput.h.

◆ SetS3OutputPath() [1/3]

void Aws::SageMaker::Model::TransformOutput::SetS3OutputPath ( Aws::String &&  value)
inline

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.

Definition at line 119 of file TransformOutput.h.

◆ SetS3OutputPath() [2/3]

void Aws::SageMaker::Model::TransformOutput::SetS3OutputPath ( const Aws::String value)
inline

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.

Definition at line 99 of file TransformOutput.h.

◆ SetS3OutputPath() [3/3]

void Aws::SageMaker::Model::TransformOutput::SetS3OutputPath ( const char *  value)
inline

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.

Definition at line 139 of file TransformOutput.h.

◆ WithAccept() [1/3]

TransformOutput& Aws::SageMaker::Model::TransformOutput::WithAccept ( Aws::String &&  value)
inline

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.

Definition at line 242 of file TransformOutput.h.

◆ WithAccept() [2/3]

TransformOutput& Aws::SageMaker::Model::TransformOutput::WithAccept ( const Aws::String value)
inline

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.

Definition at line 236 of file TransformOutput.h.

◆ WithAccept() [3/3]

TransformOutput& Aws::SageMaker::Model::TransformOutput::WithAccept ( const char *  value)
inline

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.

Definition at line 248 of file TransformOutput.h.

◆ WithAssembleWith() [1/2]

TransformOutput& Aws::SageMaker::Model::TransformOutput::WithAssembleWith ( AssemblyType &&  value)
inline

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.

Definition at line 297 of file TransformOutput.h.

◆ WithAssembleWith() [2/2]

TransformOutput& Aws::SageMaker::Model::TransformOutput::WithAssembleWith ( const AssemblyType value)
inline

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.

Definition at line 289 of file TransformOutput.h.

◆ WithKmsKeyId() [1/3]

TransformOutput& Aws::SageMaker::Model::TransformOutput::WithKmsKeyId ( Aws::String &&  value)
inline

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.

Definition at line 452 of file TransformOutput.h.

◆ WithKmsKeyId() [2/3]

TransformOutput& Aws::SageMaker::Model::TransformOutput::WithKmsKeyId ( const Aws::String value)
inline

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.

Definition at line 430 of file TransformOutput.h.

◆ WithKmsKeyId() [3/3]

TransformOutput& Aws::SageMaker::Model::TransformOutput::WithKmsKeyId ( const char *  value)
inline

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.

Definition at line 474 of file TransformOutput.h.

◆ WithS3OutputPath() [1/3]

TransformOutput& Aws::SageMaker::Model::TransformOutput::WithS3OutputPath ( Aws::String &&  value)
inline

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.

Definition at line 179 of file TransformOutput.h.

◆ WithS3OutputPath() [2/3]

TransformOutput& Aws::SageMaker::Model::TransformOutput::WithS3OutputPath ( const Aws::String value)
inline

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.

Definition at line 159 of file TransformOutput.h.

◆ WithS3OutputPath() [3/3]

TransformOutput& Aws::SageMaker::Model::TransformOutput::WithS3OutputPath ( const char *  value)
inline

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.

Definition at line 199 of file TransformOutput.h.


The documentation for this class was generated from the following file: