amazonka-comprehend-2.0: Amazon Comprehend SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Comprehend.StopEntitiesDetectionJob

Description

Stops an entities detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Synopsis

Creating a Request

data StopEntitiesDetectionJob Source #

See: newStopEntitiesDetectionJob smart constructor.

Constructors

StopEntitiesDetectionJob' 

Fields

  • jobId :: Text

    The identifier of the entities detection job to stop.

Instances

Instances details
ToJSON StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

ToHeaders StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

ToPath StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

ToQuery StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

AWSRequest StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Generic StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Associated Types

type Rep StopEntitiesDetectionJob :: Type -> Type #

Read StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Show StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

NFData StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Eq StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Hashable StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

type AWSResponse StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

type Rep StopEntitiesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

type Rep StopEntitiesDetectionJob = D1 ('MetaData "StopEntitiesDetectionJob" "Amazonka.Comprehend.StopEntitiesDetectionJob" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "StopEntitiesDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopEntitiesDetectionJob Source #

Create a value of StopEntitiesDetectionJob 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:

StopEntitiesDetectionJob, stopEntitiesDetectionJob_jobId - The identifier of the entities detection job to stop.

Request Lenses

stopEntitiesDetectionJob_jobId :: Lens' StopEntitiesDetectionJob Text Source #

The identifier of the entities detection job to stop.

Destructuring the Response

data StopEntitiesDetectionJobResponse Source #

See: newStopEntitiesDetectionJobResponse smart constructor.

Constructors

StopEntitiesDetectionJobResponse' 

Fields

  • jobId :: Maybe Text

    The identifier of the entities detection job to stop.

  • jobStatus :: Maybe JobStatus

    Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopEntitiesDetectionJob operation.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic StopEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Associated Types

type Rep StopEntitiesDetectionJobResponse :: Type -> Type #

Read StopEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Show StopEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

NFData StopEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Eq StopEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

type Rep StopEntitiesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

type Rep StopEntitiesDetectionJobResponse = D1 ('MetaData "StopEntitiesDetectionJobResponse" "Amazonka.Comprehend.StopEntitiesDetectionJob" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "StopEntitiesDetectionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStopEntitiesDetectionJobResponse Source #

Create a value of StopEntitiesDetectionJobResponse 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:

StopEntitiesDetectionJob, stopEntitiesDetectionJobResponse_jobId - The identifier of the entities detection job to stop.

StopEntitiesDetectionJobResponse, stopEntitiesDetectionJobResponse_jobStatus - Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopEntitiesDetectionJob operation.

$sel:httpStatus:StopEntitiesDetectionJobResponse', stopEntitiesDetectionJobResponse_httpStatus - The response's http status code.

Response Lenses

stopEntitiesDetectionJobResponse_jobId :: Lens' StopEntitiesDetectionJobResponse (Maybe Text) Source #

The identifier of the entities detection job to stop.

stopEntitiesDetectionJobResponse_jobStatus :: Lens' StopEntitiesDetectionJobResponse (Maybe JobStatus) Source #

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopEntitiesDetectionJob operation.