libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SageMaker.DescribeLabelingJob

Description

Gets information about a labeling job.

Synopsis

Creating a Request

data DescribeLabelingJob Source #

See: newDescribeLabelingJob smart constructor.

Constructors

DescribeLabelingJob' 

Fields

Instances

Instances details
Eq DescribeLabelingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

Read DescribeLabelingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

Show DescribeLabelingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

Generic DescribeLabelingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

Associated Types

type Rep DescribeLabelingJob :: Type -> Type #

NFData DescribeLabelingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

Methods

rnf :: DescribeLabelingJob -> () #

Hashable DescribeLabelingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

ToJSON DescribeLabelingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

AWSRequest DescribeLabelingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

Associated Types

type AWSResponse DescribeLabelingJob #

ToHeaders DescribeLabelingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

ToPath DescribeLabelingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

ToQuery DescribeLabelingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

type Rep DescribeLabelingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

type Rep DescribeLabelingJob = D1 ('MetaData "DescribeLabelingJob" "Amazonka.SageMaker.DescribeLabelingJob" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeLabelingJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "labelingJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeLabelingJob Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

newDescribeLabelingJob Source #

Create a value of DescribeLabelingJob 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:labelingJobName:DescribeLabelingJob', describeLabelingJob_labelingJobName - The name of the labeling job to return information for.

Request Lenses

describeLabelingJob_labelingJobName :: Lens' DescribeLabelingJob Text Source #

The name of the labeling job to return information for.

Destructuring the Response

data DescribeLabelingJobResponse Source #

See: newDescribeLabelingJobResponse smart constructor.

Constructors

DescribeLabelingJobResponse' 

Fields

Instances

Instances details
Eq DescribeLabelingJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

Read DescribeLabelingJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

Show DescribeLabelingJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

Generic DescribeLabelingJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

Associated Types

type Rep DescribeLabelingJobResponse :: Type -> Type #

NFData DescribeLabelingJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

type Rep DescribeLabelingJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeLabelingJob

type Rep DescribeLabelingJobResponse = D1 ('MetaData "DescribeLabelingJobResponse" "Amazonka.SageMaker.DescribeLabelingJob" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeLabelingJobResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "labelingJobAlgorithmsConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LabelingJobAlgorithmsConfig))) :*: (S1 ('MetaSel ('Just "labelCategoryConfigS3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stoppingConditions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LabelingJobStoppingConditions)))) :*: ((S1 ('MetaSel ('Just "labelAttributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "labelingJobOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LabelingJobOutput))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "labelingJobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LabelingJobStatus))))) :*: (((S1 ('MetaSel ('Just "labelCounters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LabelCounters) :*: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :*: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: (S1 ('MetaSel ('Just "jobReferenceCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "labelingJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :*: ((S1 ('MetaSel ('Just "labelingJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "inputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LabelingJobInputConfig)) :*: (S1 ('MetaSel ('Just "outputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LabelingJobOutputConfig) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "humanTaskConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HumanTaskConfig)))))))

newDescribeLabelingJobResponse Source #

Create a value of DescribeLabelingJobResponse 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:failureReason:DescribeLabelingJobResponse', describeLabelingJobResponse_failureReason - If the job failed, the reason that it failed.

$sel:labelingJobAlgorithmsConfig:DescribeLabelingJobResponse', describeLabelingJobResponse_labelingJobAlgorithmsConfig - Configuration information for automated data labeling.

$sel:labelCategoryConfigS3Uri:DescribeLabelingJobResponse', describeLabelingJobResponse_labelCategoryConfigS3Uri - The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:

  • Semantic segmentation labeling jobs using automated labeling: 20 labels
  • Box bounding labeling jobs (all): 10 labels

The file is a JSON structure in the following format:

{
 "document-version": "2018-11-28"
 "labels": [
 {
 "label": "label 1"
 },
 {
 "label": "label 2"
 },
 ...
 {
 "label": "label n"
 }
 ]
}

$sel:stoppingConditions:DescribeLabelingJobResponse', describeLabelingJobResponse_stoppingConditions - A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.

$sel:labelAttributeName:DescribeLabelingJobResponse', describeLabelingJobResponse_labelAttributeName - The attribute used as the label in the output manifest file.

$sel:labelingJobOutput:DescribeLabelingJobResponse', describeLabelingJobResponse_labelingJobOutput - The location of the output produced by the labeling job.

$sel:tags:DescribeLabelingJobResponse', describeLabelingJobResponse_tags - 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 Tagging Amazon Web Services Resources.

$sel:httpStatus:DescribeLabelingJobResponse', describeLabelingJobResponse_httpStatus - The response's http status code.

$sel:labelingJobStatus:DescribeLabelingJobResponse', describeLabelingJobResponse_labelingJobStatus - The processing status of the labeling job.

$sel:labelCounters:DescribeLabelingJobResponse', describeLabelingJobResponse_labelCounters - 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.

$sel:creationTime:DescribeLabelingJobResponse', describeLabelingJobResponse_creationTime - The date and time that the labeling job was created.

$sel:lastModifiedTime:DescribeLabelingJobResponse', describeLabelingJobResponse_lastModifiedTime - The date and time that the labeling job was last updated.

$sel:jobReferenceCode:DescribeLabelingJobResponse', describeLabelingJobResponse_jobReferenceCode - A unique identifier for work done as part of a labeling job.

$sel:labelingJobName:DescribeLabelingJob', describeLabelingJobResponse_labelingJobName - The name assigned to the labeling job when it was created.

$sel:labelingJobArn:DescribeLabelingJobResponse', describeLabelingJobResponse_labelingJobArn - The Amazon Resource Name (ARN) of the labeling job.

$sel:inputConfig:DescribeLabelingJobResponse', describeLabelingJobResponse_inputConfig - 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.

$sel:outputConfig:DescribeLabelingJobResponse', describeLabelingJobResponse_outputConfig - 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.

$sel:roleArn:DescribeLabelingJobResponse', describeLabelingJobResponse_roleArn - The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.

$sel:humanTaskConfig:DescribeLabelingJobResponse', describeLabelingJobResponse_humanTaskConfig - Configuration information required for human workers to complete a labeling task.

Response Lenses

describeLabelingJobResponse_labelCategoryConfigS3Uri :: Lens' DescribeLabelingJobResponse (Maybe Text) Source #

The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:

  • Semantic segmentation labeling jobs using automated labeling: 20 labels
  • Box bounding labeling jobs (all): 10 labels

The file is a JSON structure in the following format:

{
 "document-version": "2018-11-28"
 "labels": [
 {
 "label": "label 1"
 },
 {
 "label": "label 2"
 },
 ...
 {
 "label": "label n"
 }
 ]
}

describeLabelingJobResponse_stoppingConditions :: Lens' DescribeLabelingJobResponse (Maybe LabelingJobStoppingConditions) Source #

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.

describeLabelingJobResponse_labelAttributeName :: Lens' DescribeLabelingJobResponse (Maybe Text) Source #

The attribute used as the label in the output manifest file.

describeLabelingJobResponse_tags :: Lens' DescribeLabelingJobResponse (Maybe [Tag]) Source #

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 Tagging Amazon Web Services Resources.

describeLabelingJobResponse_labelCounters :: Lens' DescribeLabelingJobResponse LabelCounters Source #

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.

describeLabelingJobResponse_creationTime :: Lens' DescribeLabelingJobResponse UTCTime Source #

The date and time that the labeling job was created.

describeLabelingJobResponse_lastModifiedTime :: Lens' DescribeLabelingJobResponse UTCTime Source #

The date and time that the labeling job was last updated.

describeLabelingJobResponse_jobReferenceCode :: Lens' DescribeLabelingJobResponse Text Source #

A unique identifier for work done as part of a labeling job.

describeLabelingJobResponse_labelingJobName :: Lens' DescribeLabelingJobResponse Text Source #

The name assigned to the labeling job when it was created.

describeLabelingJobResponse_labelingJobArn :: Lens' DescribeLabelingJobResponse Text Source #

The Amazon Resource Name (ARN) of the labeling job.

describeLabelingJobResponse_inputConfig :: Lens' DescribeLabelingJobResponse LabelingJobInputConfig Source #

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.

describeLabelingJobResponse_outputConfig :: Lens' DescribeLabelingJobResponse LabelingJobOutputConfig Source #

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.

describeLabelingJobResponse_roleArn :: Lens' DescribeLabelingJobResponse Text Source #

The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.

describeLabelingJobResponse_humanTaskConfig :: Lens' DescribeLabelingJobResponse HumanTaskConfig Source #

Configuration information required for human workers to complete a labeling task.