/AWS1/CL_SGMLABELINGJOBOUTCFG¶
Output configuration information for a labeling job.
CONSTRUCTOR
¶
IMPORTING¶
Required arguments:¶
iv_s3outputpath
TYPE /AWS1/SGMS3URI
/AWS1/SGMS3URI
¶
The Amazon S3 location to write output data.
Optional arguments:¶
iv_kmskeyid
TYPE /AWS1/SGMKMSKEYID
/AWS1/SGMKMSKEYID
¶
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 ofs3:x-amz-server-side-encryption
to"aws:kms"
. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
iv_snstopicarn
TYPE /AWS1/SGMSNSTOPICARN
/AWS1/SGMSNSTOPICARN
¶
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
inOutputConfig
, 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.
Queryable Attributes¶
S3OutputPath¶
The Amazon S3 location to write output data.
Accessible with the following methods¶
Method | Description |
---|---|
GET_S3OUTPUTPATH() |
Getter for S3OUTPUTPATH, with configurable default |
ASK_S3OUTPUTPATH() |
Getter for S3OUTPUTPATH w/ exceptions if field has no value |
HAS_S3OUTPUTPATH() |
Determine if S3OUTPUTPATH has a value |
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 ofs3:x-amz-server-side-encryption
to"aws:kms"
. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
Accessible with the following methods¶
Method | Description |
---|---|
GET_KMSKEYID() |
Getter for KMSKEYID, with configurable default |
ASK_KMSKEYID() |
Getter for KMSKEYID w/ exceptions if field has no value |
HAS_KMSKEYID() |
Determine if KMSKEYID has a value |
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
inOutputConfig
, 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.
Accessible with the following methods¶
Method | Description |
---|---|
GET_SNSTOPICARN() |
Getter for SNSTOPICARN, with configurable default |
ASK_SNSTOPICARN() |
Getter for SNSTOPICARN w/ exceptions if field has no value |
HAS_SNSTOPICARN() |
Determine if SNSTOPICARN has a value |