Amazonka.SageMaker.Types.LabelingJobOutputConfig

Documentation

data LabelingJobOutputConfig

Output configuration information for a labeling job.

See: newLabelingJobOutputConfig smart constructor.

Constructors

LabelingJobOutputConfig'

Fields

• kmsKeyId :: Maybe Text

  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 :: Maybe Text

  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.

• s3OutputPath :: Text

  The Amazon S3 location to write output data.

Instances

FromJSON LabelingJobOutputConfig

Defined in Amazonka.SageMaker.Types.LabelingJobOutputConfig

Methods

parseJSON :: Value -> Parser LabelingJobOutputConfig

parseJSONList :: Value -> Parser [LabelingJobOutputConfig]

ToJSON LabelingJobOutputConfig

Defined in Amazonka.SageMaker.Types.LabelingJobOutputConfig

Methods

toJSON :: LabelingJobOutputConfig -> Value

toEncoding :: LabelingJobOutputConfig -> Encoding

toJSONList :: [LabelingJobOutputConfig] -> Value

toEncodingList :: [LabelingJobOutputConfig] -> Encoding

Generic LabelingJobOutputConfig

Defined in Amazonka.SageMaker.Types.LabelingJobOutputConfig

Associated Types

type Rep LabelingJobOutputConfig :: Type -> Type

Methods

from :: LabelingJobOutputConfig -> Rep LabelingJobOutputConfig x

to :: Rep LabelingJobOutputConfig x -> LabelingJobOutputConfig

Read LabelingJobOutputConfig

Defined in Amazonka.SageMaker.Types.LabelingJobOutputConfig

Methods

readsPrec :: Int -> ReadS LabelingJobOutputConfig

readList :: ReadS [LabelingJobOutputConfig]

readPrec :: ReadPrec LabelingJobOutputConfig

readListPrec :: ReadPrec [LabelingJobOutputConfig]

Show LabelingJobOutputConfig

Defined in Amazonka.SageMaker.Types.LabelingJobOutputConfig

Methods

showsPrec :: Int -> LabelingJobOutputConfig -> ShowS

show :: LabelingJobOutputConfig -> String

showList :: [LabelingJobOutputConfig] -> ShowS

NFData LabelingJobOutputConfig

Defined in Amazonka.SageMaker.Types.LabelingJobOutputConfig

Methods

rnf :: LabelingJobOutputConfig -> ()

Eq LabelingJobOutputConfig

Defined in Amazonka.SageMaker.Types.LabelingJobOutputConfig

Methods

(==) :: LabelingJobOutputConfig -> LabelingJobOutputConfig -> Bool

(/=) :: LabelingJobOutputConfig -> LabelingJobOutputConfig -> Bool

Hashable LabelingJobOutputConfig

Defined in Amazonka.SageMaker.Types.LabelingJobOutputConfig

Methods

hashWithSalt :: Int -> LabelingJobOutputConfig -> Int

hash :: LabelingJobOutputConfig -> Int

type Rep LabelingJobOutputConfig

Defined in Amazonka.SageMaker.Types.LabelingJobOutputConfig

type Rep LabelingJobOutputConfig = D1 ('MetaData "LabelingJobOutputConfig" "Amazonka.SageMaker.Types.LabelingJobOutputConfig" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "LabelingJobOutputConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "snsTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3OutputPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newLabelingJobOutputConfig

Arguments

:: Text

$sel:s3OutputPath:LabelingJobOutputConfig'

-> LabelingJobOutputConfig

Create a value of LabelingJobOutputConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:kmsKeyId:LabelingJobOutputConfig', labelingJobOutputConfig_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.

$sel:snsTopicArn:LabelingJobOutputConfig', labelingJobOutputConfig_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.

$sel:s3OutputPath:LabelingJobOutputConfig', labelingJobOutputConfig_s3OutputPath - The Amazon S3 location to write output data.

labelingJobOutputConfig_kmsKeyId :: Lens' LabelingJobOutputConfig (Maybe Text)

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.

labelingJobOutputConfig_snsTopicArn :: Lens' LabelingJobOutputConfig (Maybe Text)

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.

labelingJobOutputConfig_s3OutputPath :: Lens' LabelingJobOutputConfig Text

The Amazon S3 location to write output data.