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

#include <LabelingJobOutputConfig.h>

Public Member Functions

 LabelingJobOutputConfig ()
 
 LabelingJobOutputConfig (Aws::Utils::Json::JsonView jsonValue)
 
LabelingJobOutputConfigoperator= (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)
 
LabelingJobOutputConfigWithS3OutputPath (const Aws::String &value)
 
LabelingJobOutputConfigWithS3OutputPath (Aws::String &&value)
 
LabelingJobOutputConfigWithS3OutputPath (const char *value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
LabelingJobOutputConfigWithKmsKeyId (const Aws::String &value)
 
LabelingJobOutputConfigWithKmsKeyId (Aws::String &&value)
 
LabelingJobOutputConfigWithKmsKeyId (const char *value)
 
const Aws::StringGetSnsTopicArn () const
 
bool SnsTopicArnHasBeenSet () const
 
void SetSnsTopicArn (const Aws::String &value)
 
void SetSnsTopicArn (Aws::String &&value)
 
void SetSnsTopicArn (const char *value)
 
LabelingJobOutputConfigWithSnsTopicArn (const Aws::String &value)
 
LabelingJobOutputConfigWithSnsTopicArn (Aws::String &&value)
 
LabelingJobOutputConfigWithSnsTopicArn (const char *value)
 

Detailed Description

Output configuration information for a labeling job.

See Also:

AWS API Reference

Definition at line 32 of file LabelingJobOutputConfig.h.

Constructor & Destructor Documentation

◆ LabelingJobOutputConfig() [1/2]

Aws::SageMaker::Model::LabelingJobOutputConfig::LabelingJobOutputConfig ( )

◆ LabelingJobOutputConfig() [2/2]

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

Member Function Documentation

◆ GetKmsKeyId()

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

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role's account to encrypt your output data.

If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

Definition at line 98 of file LabelingJobOutputConfig.h.

◆ GetS3OutputPath()

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

The Amazon S3 location to write output data.

Definition at line 44 of file LabelingJobOutputConfig.h.

◆ GetSnsTopicArn()

const Aws::String& Aws::SageMaker::Model::LabelingJobOutputConfig::GetSnsTopicArn ( ) const
inline

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.

If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

To learn more, see Receive Output Data from a Streaming Labeling Job.

Definition at line 238 of file LabelingJobOutputConfig.h.

◆ Jsonize()

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

◆ KmsKeyIdHasBeenSet()

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

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role's account to encrypt your output data.

If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

Definition at line 116 of file LabelingJobOutputConfig.h.

◆ operator=()

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

◆ S3OutputPathHasBeenSet()

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

The Amazon S3 location to write output data.

Definition at line 49 of file LabelingJobOutputConfig.h.

◆ SetKmsKeyId() [1/3]

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

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role's account to encrypt your output data.

If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

Definition at line 152 of file LabelingJobOutputConfig.h.

◆ SetKmsKeyId() [2/3]

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

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role's account to encrypt your output data.

If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

Definition at line 134 of file LabelingJobOutputConfig.h.

◆ SetKmsKeyId() [3/3]

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

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role's account to encrypt your output data.

If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

Definition at line 170 of file LabelingJobOutputConfig.h.

◆ SetS3OutputPath() [1/3]

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

The Amazon S3 location to write output data.

Definition at line 59 of file LabelingJobOutputConfig.h.

◆ SetS3OutputPath() [2/3]

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

The Amazon S3 location to write output data.

Definition at line 54 of file LabelingJobOutputConfig.h.

◆ SetS3OutputPath() [3/3]

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

The Amazon S3 location to write output data.

Definition at line 64 of file LabelingJobOutputConfig.h.

◆ SetSnsTopicArn() [1/3]

void Aws::SageMaker::Model::LabelingJobOutputConfig::SetSnsTopicArn ( Aws::String &&  value)
inline

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.

If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

To learn more, see Receive Output Data from a Streaming Labeling Job.

Definition at line 277 of file LabelingJobOutputConfig.h.

◆ SetSnsTopicArn() [2/3]

void Aws::SageMaker::Model::LabelingJobOutputConfig::SetSnsTopicArn ( const Aws::String value)
inline

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.

If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

To learn more, see Receive Output Data from a Streaming Labeling Job.

Definition at line 264 of file LabelingJobOutputConfig.h.

◆ SetSnsTopicArn() [3/3]

void Aws::SageMaker::Model::LabelingJobOutputConfig::SetSnsTopicArn ( const char *  value)
inline

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.

If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

To learn more, see Receive Output Data from a Streaming Labeling Job.

Definition at line 290 of file LabelingJobOutputConfig.h.

◆ SnsTopicArnHasBeenSet()

bool Aws::SageMaker::Model::LabelingJobOutputConfig::SnsTopicArnHasBeenSet ( ) const
inline

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.

If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

To learn more, see Receive Output Data from a Streaming Labeling Job.

Definition at line 251 of file LabelingJobOutputConfig.h.

◆ WithKmsKeyId() [1/3]

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

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role's account to encrypt your output data.

If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

Definition at line 206 of file LabelingJobOutputConfig.h.

◆ WithKmsKeyId() [2/3]

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

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role's account to encrypt your output data.

If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

Definition at line 188 of file LabelingJobOutputConfig.h.

◆ WithKmsKeyId() [3/3]

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

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role's account to encrypt your output data.

If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

Definition at line 224 of file LabelingJobOutputConfig.h.

◆ WithS3OutputPath() [1/3]

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

The Amazon S3 location to write output data.

Definition at line 74 of file LabelingJobOutputConfig.h.

◆ WithS3OutputPath() [2/3]

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

The Amazon S3 location to write output data.

Definition at line 69 of file LabelingJobOutputConfig.h.

◆ WithS3OutputPath() [3/3]

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

The Amazon S3 location to write output data.

Definition at line 79 of file LabelingJobOutputConfig.h.

◆ WithSnsTopicArn() [1/3]

LabelingJobOutputConfig& Aws::SageMaker::Model::LabelingJobOutputConfig::WithSnsTopicArn ( Aws::String &&  value)
inline

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.

If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

To learn more, see Receive Output Data from a Streaming Labeling Job.

Definition at line 316 of file LabelingJobOutputConfig.h.

◆ WithSnsTopicArn() [2/3]

LabelingJobOutputConfig& Aws::SageMaker::Model::LabelingJobOutputConfig::WithSnsTopicArn ( const Aws::String value)
inline

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.

If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

To learn more, see Receive Output Data from a Streaming Labeling Job.

Definition at line 303 of file LabelingJobOutputConfig.h.

◆ WithSnsTopicArn() [3/3]

LabelingJobOutputConfig& Aws::SageMaker::Model::LabelingJobOutputConfig::WithSnsTopicArn ( const char *  value)
inline

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.

If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

To learn more, see Receive Output Data from a Streaming Labeling Job.

Definition at line 329 of file LabelingJobOutputConfig.h.


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