AWS SDK for C++  1.8.76
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 AWS Key Management Service ID of the key used to encrypt the output data, if any.

If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for LabelingJobOutputConfig. 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.

The KMS key policy must grant permission to the IAM role that you specify in your CreateLabelingJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

Definition at line 103 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.

When workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

You must provide a value for this parameter if you provide an Amazon SNS input topic in SnsDataSource in InputConfig.

Definition at line 274 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 AWS Key Management Service ID of the key used to encrypt the output data, if any.

If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for LabelingJobOutputConfig. 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.

The KMS key policy must grant permission to the IAM role that you specify in your CreateLabelingJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

Definition at line 126 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 ( const Aws::String value)
inline

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

If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for LabelingJobOutputConfig. 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.

The KMS key policy must grant permission to the IAM role that you specify in your CreateLabelingJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

Definition at line 149 of file LabelingJobOutputConfig.h.

◆ SetKmsKeyId() [2/3]

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

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

If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for LabelingJobOutputConfig. 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.

The KMS key policy must grant permission to the IAM role that you specify in your CreateLabelingJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

Definition at line 172 of file LabelingJobOutputConfig.h.

◆ SetKmsKeyId() [3/3]

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

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

If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for LabelingJobOutputConfig. 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.

The KMS key policy must grant permission to the IAM role that you specify in your CreateLabelingJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

Definition at line 195 of file LabelingJobOutputConfig.h.

◆ SetS3OutputPath() [1/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() [2/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() [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 ( const Aws::String value)
inline

An Amazon Simple Notification Service (Amazon SNS) output topic ARN.

When workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

You must provide a value for this parameter if you provide an Amazon SNS input topic in SnsDataSource in InputConfig.

Definition at line 292 of file LabelingJobOutputConfig.h.

◆ SetSnsTopicArn() [2/3]

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

An Amazon Simple Notification Service (Amazon SNS) output topic ARN.

When workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

You must provide a value for this parameter if you provide an Amazon SNS input topic in SnsDataSource in InputConfig.

Definition at line 301 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.

When workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

You must provide a value for this parameter if you provide an Amazon SNS input topic in SnsDataSource in InputConfig.

Definition at line 310 of file LabelingJobOutputConfig.h.

◆ SnsTopicArnHasBeenSet()

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

An Amazon Simple Notification Service (Amazon SNS) output topic ARN.

When workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

You must provide a value for this parameter if you provide an Amazon SNS input topic in SnsDataSource in InputConfig.

Definition at line 283 of file LabelingJobOutputConfig.h.

◆ WithKmsKeyId() [1/3]

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

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

If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for LabelingJobOutputConfig. 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.

The KMS key policy must grant permission to the IAM role that you specify in your CreateLabelingJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

Definition at line 218 of file LabelingJobOutputConfig.h.

◆ WithKmsKeyId() [2/3]

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

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

If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for LabelingJobOutputConfig. 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.

The KMS key policy must grant permission to the IAM role that you specify in your CreateLabelingJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

Definition at line 241 of file LabelingJobOutputConfig.h.

◆ WithKmsKeyId() [3/3]

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

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

If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for LabelingJobOutputConfig. 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.

The KMS key policy must grant permission to the IAM role that you specify in your CreateLabelingJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

Definition at line 264 of file LabelingJobOutputConfig.h.

◆ WithS3OutputPath() [1/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() [2/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() [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 ( const Aws::String value)
inline

An Amazon Simple Notification Service (Amazon SNS) output topic ARN.

When workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

You must provide a value for this parameter if you provide an Amazon SNS input topic in SnsDataSource in InputConfig.

Definition at line 319 of file LabelingJobOutputConfig.h.

◆ WithSnsTopicArn() [2/3]

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

An Amazon Simple Notification Service (Amazon SNS) output topic ARN.

When workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

You must provide a value for this parameter if you provide an Amazon SNS input topic in SnsDataSource in InputConfig.

Definition at line 328 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.

When workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

You must provide a value for this parameter if you provide an Amazon SNS input topic in SnsDataSource in InputConfig.

Definition at line 337 of file LabelingJobOutputConfig.h.


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