import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manage an Amazon SageMaker labeling job. * * ## Example Usage * * Basic usage: * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * // https://docs.aws.amazon.com/sagemaker/latest/dg/sms-named-entity-recg.html#sms-creating-ner-api. * const test = new aws.sagemaker.LabelingJob("test", { * humanTaskConfig: { * uiConfig: { * humanTaskUiArn: "arn:aws:sagemaker:us-west-2:394669845002:human-task-ui/NamedEntityRecognition", * }, * annotationConsolidationConfig: { * annotationConsolidationLambdaArn: "arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition", * }, * numberOfHumanWorkersPerDataObject: 1, * taskDescription: "Apply the labels provided to specific words or phrases within the larger text block.", * taskTitle: "Named entity Recognition task", * taskTimeLimitInSeconds: 28800, * workteamArn: example.arn, * preHumanTaskLambdaArn: "arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition", * }, * inputConfig: { * dataSource: { * snsDataSource: { * snsTopicArn: exampleAwsSnsTopic.arn, * }, * }, * }, * outputConfig: { * s3OutputPath: `s3://${exampleAwsS3Bucket.bucket}/`, * }, * labelAttributeName: "label1", * labelingJobName: "my-labeling-job", * roleArn: exampleAwsIamRole.arn, * labelCategoryConfigS3Uri: `s3://${exampleAwsS3Bucket.bucket}/${exampleAwsS3Object.key}`, * }); * ``` * * ## Import * * Using `pulumi import`, import labeling jobs using the `labelingJobName`. For example: * * ```sh * $ pulumi import aws:sagemaker/labelingJob:LabelingJob example my-labeling-job * ``` */ export declare class LabelingJob extends pulumi.CustomResource { /** * Get an existing LabelingJob resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: LabelingJobState, opts?: pulumi.CustomResourceOptions): LabelingJob; /** * Returns true if the given object is an instance of LabelingJob. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is LabelingJob; /** * If the job failed, the reason that it failed. */ readonly failureReason: pulumi.Output; /** * Configuration information required for human workers to complete a labeling task. Fields are documented below. */ readonly humanTaskConfig: pulumi.Output; /** * Input data for the labeling job. Fields are documented below. */ readonly inputConfig: pulumi.Output; /** * Unique identifier for work done as part of a labeling job. */ readonly jobReferenceCode: pulumi.Output; /** * Attribute name to use for the label in the output manifest file. */ readonly labelAttributeName: pulumi.Output; /** * S3 URI of the file that defines the categories used to label the data objects. */ readonly labelCategoryConfigS3Uri: pulumi.Output; /** * A breakdown of the number of objects labeled. */ readonly labelCounters: pulumi.Output; /** * Information required to perform automated data labeling.. Fields are documented below. */ readonly labelingJobAlgorithmsConfig: pulumi.Output; /** * ARN of the labeling job. */ readonly labelingJobArn: pulumi.Output; /** * Name of the labeling job. */ readonly labelingJobName: pulumi.Output; /** * Processing status of the labeling job. */ readonly labelingJobStatus: pulumi.Output; /** * Location of the output data. Fields are documented below. */ readonly outputConfig: pulumi.Output; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ readonly region: pulumi.Output; /** * ARN of IAM role that Amazon SageMaker assumes to perform tasks during data labeling. */ readonly roleArn: pulumi.Output; /** * Conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped. Fields are documented below. */ readonly stoppingConditions: pulumi.Output; /** * A mapping of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ readonly tagsAll: pulumi.Output<{ [key: string]: string; }>; /** * Create a LabelingJob resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: LabelingJobArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering LabelingJob resources. */ export interface LabelingJobState { /** * If the job failed, the reason that it failed. */ failureReason?: pulumi.Input; /** * Configuration information required for human workers to complete a labeling task. Fields are documented below. */ humanTaskConfig?: pulumi.Input; /** * Input data for the labeling job. Fields are documented below. */ inputConfig?: pulumi.Input; /** * Unique identifier for work done as part of a labeling job. */ jobReferenceCode?: pulumi.Input; /** * Attribute name to use for the label in the output manifest file. */ labelAttributeName?: pulumi.Input; /** * S3 URI of the file that defines the categories used to label the data objects. */ labelCategoryConfigS3Uri?: pulumi.Input; /** * A breakdown of the number of objects labeled. */ labelCounters?: pulumi.Input[] | undefined>; /** * Information required to perform automated data labeling.. Fields are documented below. */ labelingJobAlgorithmsConfig?: pulumi.Input; /** * ARN of the labeling job. */ labelingJobArn?: pulumi.Input; /** * Name of the labeling job. */ labelingJobName?: pulumi.Input; /** * Processing status of the labeling job. */ labelingJobStatus?: pulumi.Input; /** * Location of the output data. Fields are documented below. */ outputConfig?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * ARN of IAM role that Amazon SageMaker assumes to perform tasks during data labeling. */ roleArn?: pulumi.Input; /** * Conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped. Fields are documented below. */ stoppingConditions?: pulumi.Input[] | undefined>; /** * A mapping of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ tagsAll?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; } /** * The set of arguments for constructing a LabelingJob resource. */ export interface LabelingJobArgs { /** * Configuration information required for human workers to complete a labeling task. Fields are documented below. */ humanTaskConfig: pulumi.Input; /** * Input data for the labeling job. Fields are documented below. */ inputConfig: pulumi.Input; /** * Attribute name to use for the label in the output manifest file. */ labelAttributeName: pulumi.Input; /** * S3 URI of the file that defines the categories used to label the data objects. */ labelCategoryConfigS3Uri?: pulumi.Input; /** * Information required to perform automated data labeling.. Fields are documented below. */ labelingJobAlgorithmsConfig?: pulumi.Input; /** * Name of the labeling job. */ labelingJobName: pulumi.Input; /** * Location of the output data. Fields are documented below. */ outputConfig: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * ARN of IAM role that Amazon SageMaker assumes to perform tasks during data labeling. */ roleArn: pulumi.Input; /** * Conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped. Fields are documented below. */ stoppingConditions?: pulumi.Input[] | undefined>; /** * A mapping of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; } //# sourceMappingURL=labelingJob.d.ts.map