1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
/// Constructs a fluent builder for the [`DescribeLabelingJob`](crate::operation::describe_labeling_job::builders::DescribeLabelingJobFluentBuilder) operation.
///
/// - The fluent builder is configurable:
/// - [`labeling_job_name(impl Into<String>)`](crate::operation::describe_labeling_job::builders::DescribeLabelingJobFluentBuilder::labeling_job_name) / [`set_labeling_job_name(Option<String>)`](crate::operation::describe_labeling_job::builders::DescribeLabelingJobFluentBuilder::set_labeling_job_name): <p>The name of the labeling job to return information for.</p>
/// - On success, responds with [`DescribeLabelingJobOutput`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput) with field(s):
/// - [`labeling_job_status(Option<LabelingJobStatus>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::labeling_job_status): <p>The processing status of the labeling job. </p>
/// - [`label_counters(Option<LabelCounters>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::label_counters): <p>Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled. </p>
/// - [`failure_reason(Option<String>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::failure_reason): <p>If the job failed, the reason that it failed. </p>
/// - [`creation_time(Option<DateTime>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::creation_time): <p>The date and time that the labeling job was created.</p>
/// - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::last_modified_time): <p>The date and time that the labeling job was last updated.</p>
/// - [`job_reference_code(Option<String>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::job_reference_code): <p>A unique identifier for work done as part of a labeling job.</p>
/// - [`labeling_job_name(Option<String>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::labeling_job_name): <p>The name assigned to the labeling job when it was created.</p>
/// - [`labeling_job_arn(Option<String>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::labeling_job_arn): <p>The Amazon Resource Name (ARN) of the labeling job.</p>
/// - [`label_attribute_name(Option<String>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::label_attribute_name): <p>The attribute used as the label in the output manifest file.</p>
/// - [`input_config(Option<LabelingJobInputConfig>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::input_config): <p>Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.</p>
/// - [`output_config(Option<LabelingJobOutputConfig>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::output_config): <p>The location of the job's output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.</p>
/// - [`role_arn(Option<String>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::role_arn): <p>The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.</p>
/// - [`label_category_config_s3_uri(Option<String>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::label_category_config_s3_uri): <p>The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:</p> <ul> <li> <p>Semantic segmentation labeling jobs using automated labeling: 20 labels</p> </li> <li> <p>Box bounding labeling jobs (all): 10 labels</p> </li> </ul> <p>The file is a JSON structure in the following format:</p> <p> <code>{</code> </p> <p> <code> "document-version": "2018-11-28"</code> </p> <p> <code> "labels": [</code> </p> <p> <code> {</code> </p> <p> <code> "label": "<i>label 1</i>"</code> </p> <p> <code> },</code> </p> <p> <code> {</code> </p> <p> <code> "label": "<i>label 2</i>"</code> </p> <p> <code> },</code> </p> <p> <code> ...</code> </p> <p> <code> {</code> </p> <p> <code> "label": "<i>label n</i>"</code> </p> <p> <code> }</code> </p> <p> <code> ]</code> </p> <p> <code>}</code> </p>
/// - [`stopping_conditions(Option<LabelingJobStoppingConditions>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::stopping_conditions): <p>A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.</p>
/// - [`labeling_job_algorithms_config(Option<LabelingJobAlgorithmsConfig>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::labeling_job_algorithms_config): <p>Configuration information for automated data labeling.</p>
/// - [`human_task_config(Option<HumanTaskConfig>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::human_task_config): <p>Configuration information required for human workers to complete a labeling task.</p>
/// - [`tags(Option<Vec<Tag>>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::tags): <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>
/// - [`labeling_job_output(Option<LabelingJobOutput>)`](crate::operation::describe_labeling_job::DescribeLabelingJobOutput::labeling_job_output): <p>The location of the output produced by the labeling job.</p>
/// - On failure, responds with [`SdkError<DescribeLabelingJobError>`](crate::operation::describe_labeling_job::DescribeLabelingJobError)
pub fn describe_labeling_job(
&self,
) -> crate::operation::describe_labeling_job::builders::DescribeLabelingJobFluentBuilder {
crate::operation::describe_labeling_job::builders::DescribeLabelingJobFluentBuilder::new(
self.handle.clone(),
)
}
}