/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace SageMaker { namespace Model { /** *

Describes the results of a transform job.

See Also:

AWS * API Reference

*/ class TransformOutput { public: AWS_SAGEMAKER_API TransformOutput(); AWS_SAGEMAKER_API TransformOutput(Aws::Utils::Json::JsonView jsonValue); AWS_SAGEMAKER_API TransformOutput& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_SAGEMAKER_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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.

*/ inline const Aws::String& GetS3OutputPath() const{ return m_s3OutputPath; } /** *

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.

*/ inline bool S3OutputPathHasBeenSet() const { return m_s3OutputPathHasBeenSet; } /** *

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.

*/ inline void SetS3OutputPath(const Aws::String& value) { m_s3OutputPathHasBeenSet = true; m_s3OutputPath = value; } /** *

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.

*/ inline void SetS3OutputPath(Aws::String&& value) { m_s3OutputPathHasBeenSet = true; m_s3OutputPath = std::move(value); } /** *

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.

*/ inline void SetS3OutputPath(const char* value) { m_s3OutputPathHasBeenSet = true; m_s3OutputPath.assign(value); } /** *

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.

*/ inline TransformOutput& WithS3OutputPath(const Aws::String& value) { SetS3OutputPath(value); return *this;} /** *

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.

*/ inline TransformOutput& WithS3OutputPath(Aws::String&& value) { SetS3OutputPath(std::move(value)); return *this;} /** *

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.

*/ inline TransformOutput& WithS3OutputPath(const char* value) { SetS3OutputPath(value); return *this;} /** *

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.

*/ inline const Aws::String& GetAccept() const{ return m_accept; } /** *

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.

*/ inline bool AcceptHasBeenSet() const { return m_acceptHasBeenSet; } /** *

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.

*/ inline void SetAccept(const Aws::String& value) { m_acceptHasBeenSet = true; m_accept = value; } /** *

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.

*/ inline void SetAccept(Aws::String&& value) { m_acceptHasBeenSet = true; m_accept = std::move(value); } /** *

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.

*/ inline void SetAccept(const char* value) { m_acceptHasBeenSet = true; m_accept.assign(value); } /** *

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.

*/ inline TransformOutput& WithAccept(const Aws::String& value) { SetAccept(value); return *this;} /** *

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.

*/ inline TransformOutput& WithAccept(Aws::String&& value) { SetAccept(std::move(value)); return *this;} /** *

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.

*/ inline TransformOutput& WithAccept(const char* value) { SetAccept(value); return *this;} /** *

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.

*/ inline const AssemblyType& GetAssembleWith() const{ return m_assembleWith; } /** *

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.

*/ inline bool AssembleWithHasBeenSet() const { return m_assembleWithHasBeenSet; } /** *

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.

*/ inline void SetAssembleWith(const AssemblyType& value) { m_assembleWithHasBeenSet = true; m_assembleWith = value; } /** *

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.

*/ inline void SetAssembleWith(AssemblyType&& value) { m_assembleWithHasBeenSet = true; m_assembleWith = std::move(value); } /** *

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.

*/ inline TransformOutput& WithAssembleWith(const AssemblyType& value) { SetAssembleWith(value); return *this;} /** *

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.

*/ inline TransformOutput& WithAssembleWith(AssemblyType&& value) { SetAssembleWith(std::move(value)); return *this;} /** *

The Amazon Web Services Key Management Service (Amazon Web Services 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 Amazon Web Services KMS in the Amazon Web Services Key * Management Service Developer Guide.

*/ inline const Aws::String& GetKmsKeyId() const{ return m_kmsKeyId; } /** *

The Amazon Web Services Key Management Service (Amazon Web Services 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 Amazon Web Services KMS in the Amazon Web Services Key * Management Service Developer Guide.

*/ inline bool KmsKeyIdHasBeenSet() const { return m_kmsKeyIdHasBeenSet; } /** *

The Amazon Web Services Key Management Service (Amazon Web Services 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 Amazon Web Services KMS in the Amazon Web Services Key * Management Service Developer Guide.

*/ inline void SetKmsKeyId(const Aws::String& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = value; } /** *

The Amazon Web Services Key Management Service (Amazon Web Services 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 Amazon Web Services KMS in the Amazon Web Services Key * Management Service Developer Guide.

*/ inline void SetKmsKeyId(Aws::String&& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = std::move(value); } /** *

The Amazon Web Services Key Management Service (Amazon Web Services 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 Amazon Web Services KMS in the Amazon Web Services Key * Management Service Developer Guide.

*/ inline void SetKmsKeyId(const char* value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId.assign(value); } /** *

The Amazon Web Services Key Management Service (Amazon Web Services 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 Amazon Web Services KMS in the Amazon Web Services Key * Management Service Developer Guide.

*/ inline TransformOutput& WithKmsKeyId(const Aws::String& value) { SetKmsKeyId(value); return *this;} /** *

The Amazon Web Services Key Management Service (Amazon Web Services 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 Amazon Web Services KMS in the Amazon Web Services Key * Management Service Developer Guide.

*/ inline TransformOutput& WithKmsKeyId(Aws::String&& value) { SetKmsKeyId(std::move(value)); return *this;} /** *

The Amazon Web Services Key Management Service (Amazon Web Services 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 Amazon Web Services KMS in the Amazon Web Services Key * Management Service Developer Guide.

*/ inline TransformOutput& WithKmsKeyId(const char* value) { SetKmsKeyId(value); return *this;} private: Aws::String m_s3OutputPath; bool m_s3OutputPathHasBeenSet = false; Aws::String m_accept; bool m_acceptHasBeenSet = false; AssemblyType m_assembleWith; bool m_assembleWithHasBeenSet = false; Aws::String m_kmsKeyId; bool m_kmsKeyIdHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws