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

Description

Stops a key phrases 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 StopKeyPhrasesDetectionJob Source #

See: newStopKeyPhrasesDetectionJob smart constructor.

Constructors

StopKeyPhrasesDetectionJob' 

Fields

  • jobId :: Text

    The identifier of the key phrases detection job to stop.

Instances

Instances details
ToJSON StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

ToHeaders StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

ToPath StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

ToQuery StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

AWSRequest StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Generic StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Associated Types

type Rep StopKeyPhrasesDetectionJob :: Type -> Type #

Read StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Show StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

NFData StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Eq StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Hashable StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

type AWSResponse StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

type Rep StopKeyPhrasesDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

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

newStopKeyPhrasesDetectionJob Source #

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

StopKeyPhrasesDetectionJob, stopKeyPhrasesDetectionJob_jobId - The identifier of the key phrases detection job to stop.

Request Lenses

stopKeyPhrasesDetectionJob_jobId :: Lens' StopKeyPhrasesDetectionJob Text Source #

The identifier of the key phrases detection job to stop.

Destructuring the Response

data StopKeyPhrasesDetectionJobResponse Source #

Constructors

StopKeyPhrasesDetectionJobResponse' 

Fields

  • jobId :: Maybe Text

    The identifier of the key phrases 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 StopKeyPhrasesDetectionJob operation.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic StopKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Associated Types

type Rep StopKeyPhrasesDetectionJobResponse :: Type -> Type #

Read StopKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Show StopKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

NFData StopKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Eq StopKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

type Rep StopKeyPhrasesDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

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

newStopKeyPhrasesDetectionJobResponse Source #

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

StopKeyPhrasesDetectionJob, stopKeyPhrasesDetectionJobResponse_jobId - The identifier of the key phrases detection job to stop.

StopKeyPhrasesDetectionJobResponse, stopKeyPhrasesDetectionJobResponse_jobStatus - Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopKeyPhrasesDetectionJob operation.

$sel:httpStatus:StopKeyPhrasesDetectionJobResponse', stopKeyPhrasesDetectionJobResponse_httpStatus - The response's http status code.

Response Lenses

stopKeyPhrasesDetectionJobResponse_jobId :: Lens' StopKeyPhrasesDetectionJobResponse (Maybe Text) Source #

The identifier of the key phrases detection job to stop.

stopKeyPhrasesDetectionJobResponse_jobStatus :: Lens' StopKeyPhrasesDetectionJobResponse (Maybe JobStatus) Source #

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