software.amazon.awssdk.services.sagemaker.model

Interface LabelingJobOutputConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<LabelingJobOutputConfig.Builder,LabelingJobOutputConfig>, SdkBuilder<LabelingJobOutputConfig.Builder,LabelingJobOutputConfig>, SdkPojo

Enclosing class:

LabelingJobOutputConfig

public static interface LabelingJobOutputConfig.Builder
extends SdkPojo, CopyableBuilder<LabelingJobOutputConfig.Builder,LabelingJobOutputConfig>

Method Summary

Modifier and Type	Method and Description
LabelingJobOutputConfig.Builder	kmsKeyId(String kmsKeyId) The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.
LabelingJobOutputConfig.Builder	s3OutputPath(String s3OutputPath) The Amazon S3 location to write output data.
LabelingJobOutputConfig.Builder	snsTopicArn(String snsTopicArn) An Amazon Simple Notification Service (Amazon SNS) output topic ARN.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

s3OutputPath

LabelingJobOutputConfig.Builder s3OutputPath(String s3OutputPath)

The Amazon S3 location to write output data.

Parameters:

s3OutputPath - The Amazon S3 location to write output data.

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

LabelingJobOutputConfig.Builder kmsKeyId(String kmsKeyId)

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.

Parameters:

kmsKeyId - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

snsTopicArn

LabelingJobOutputConfig.Builder snsTopicArn(String snsTopicArn)

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.

Parameters:

snsTopicArn - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.