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.StopSentimentDetectionJob

Description

Stops a sentiment 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 be 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 StopSentimentDetectionJob Source #

See: newStopSentimentDetectionJob smart constructor.

Constructors

StopSentimentDetectionJob' 

Fields

  • jobId :: Text

    The identifier of the sentiment detection job to stop.

Instances

Instances details
ToJSON StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

ToHeaders StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

ToPath StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

ToQuery StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

AWSRequest StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Generic StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Associated Types

type Rep StopSentimentDetectionJob :: Type -> Type #

Read StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Show StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

NFData StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Eq StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Hashable StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

type AWSResponse StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

type Rep StopSentimentDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

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

newStopSentimentDetectionJob Source #

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

StopSentimentDetectionJob, stopSentimentDetectionJob_jobId - The identifier of the sentiment detection job to stop.

Request Lenses

stopSentimentDetectionJob_jobId :: Lens' StopSentimentDetectionJob Text Source #

The identifier of the sentiment detection job to stop.

Destructuring the Response

data StopSentimentDetectionJobResponse Source #

See: newStopSentimentDetectionJobResponse smart constructor.

Constructors

StopSentimentDetectionJobResponse' 

Fields

  • jobId :: Maybe Text

    The identifier of the sentiment 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 StopSentimentDetectionJob operation.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic StopSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Associated Types

type Rep StopSentimentDetectionJobResponse :: Type -> Type #

Read StopSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Show StopSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

NFData StopSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Eq StopSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

type Rep StopSentimentDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

type Rep StopSentimentDetectionJobResponse = D1 ('MetaData "StopSentimentDetectionJobResponse" "Amazonka.Comprehend.StopSentimentDetectionJob" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "StopSentimentDetectionJobResponse'" '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))))

newStopSentimentDetectionJobResponse Source #

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

StopSentimentDetectionJob, stopSentimentDetectionJobResponse_jobId - The identifier of the sentiment detection job to stop.

StopSentimentDetectionJobResponse, stopSentimentDetectionJobResponse_jobStatus - Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.

$sel:httpStatus:StopSentimentDetectionJobResponse', stopSentimentDetectionJobResponse_httpStatus - The response's http status code.

Response Lenses

stopSentimentDetectionJobResponse_jobId :: Lens' StopSentimentDetectionJobResponse (Maybe Text) Source #

The identifier of the sentiment detection job to stop.

stopSentimentDetectionJobResponse_jobStatus :: Lens' StopSentimentDetectionJobResponse (Maybe JobStatus) Source #

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