Package software.amazon.awssdk.services.sagemaker.model

Class LabelingJobOutputConfig

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.LabelingJobOutputConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LabelingJobOutputConfig.Builder,LabelingJobOutputConfig>
@Generated("software.amazon.awssdk:codegen") public final class LabelingJobOutputConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LabelingJobOutputConfig.Builder,LabelingJobOutputConfig>

Output configuration information for a labeling job.

See Also:

  • Method Details

    • s3OutputPath

      public final String s3OutputPath()

      The Amazon S3 location to write output data.

      Returns:
      The Amazon S3 location to write output data.

    • kmsKeyId

      public final 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.

      Returns:
      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.

    • snsTopicArn

      public final 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.

      Returns:
      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.

    • toBuilder

      public LabelingJobOutputConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<LabelingJobOutputConfig.Builder,LabelingJobOutputConfig>
      Returns:
      a builder for type T

    • builder

      public static LabelingJobOutputConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LabelingJobOutputConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.