Amazonka.Comprehend.StopKeyPhrasesDetectionJob

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.

Creating a Request

data StopKeyPhrasesDetectionJob

See: newStopKeyPhrasesDetectionJob smart constructor.

Constructors

StopKeyPhrasesDetectionJob'

Fields

• jobId :: Text

  The identifier of the key phrases detection job to stop.

Instances

ToJSON StopKeyPhrasesDetectionJob

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Methods

toJSON :: StopKeyPhrasesDetectionJob -> Value

toEncoding :: StopKeyPhrasesDetectionJob -> Encoding

toJSONList :: [StopKeyPhrasesDetectionJob] -> Value

toEncodingList :: [StopKeyPhrasesDetectionJob] -> Encoding

ToHeaders StopKeyPhrasesDetectionJob

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Methods

toHeaders :: StopKeyPhrasesDetectionJob -> [Header]

ToPath StopKeyPhrasesDetectionJob

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Methods

toPath :: StopKeyPhrasesDetectionJob -> ByteString

ToQuery StopKeyPhrasesDetectionJob

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Methods

toQuery :: StopKeyPhrasesDetectionJob -> QueryString

AWSRequest StopKeyPhrasesDetectionJob

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Associated Types

type AWSResponse StopKeyPhrasesDetectionJob

Methods

request :: (Service -> Service) -> StopKeyPhrasesDetectionJob -> Request StopKeyPhrasesDetectionJob

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopKeyPhrasesDetectionJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopKeyPhrasesDetectionJob)))

Generic StopKeyPhrasesDetectionJob

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Associated Types

type Rep StopKeyPhrasesDetectionJob :: Type -> Type

Methods

from :: StopKeyPhrasesDetectionJob -> Rep StopKeyPhrasesDetectionJob x

to :: Rep StopKeyPhrasesDetectionJob x -> StopKeyPhrasesDetectionJob

Read StopKeyPhrasesDetectionJob

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Methods

readsPrec :: Int -> ReadS StopKeyPhrasesDetectionJob

readList :: ReadS [StopKeyPhrasesDetectionJob]

readPrec :: ReadPrec StopKeyPhrasesDetectionJob

readListPrec :: ReadPrec [StopKeyPhrasesDetectionJob]

Show StopKeyPhrasesDetectionJob

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Methods

showsPrec :: Int -> StopKeyPhrasesDetectionJob -> ShowS

show :: StopKeyPhrasesDetectionJob -> String

showList :: [StopKeyPhrasesDetectionJob] -> ShowS

NFData StopKeyPhrasesDetectionJob

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Methods

rnf :: StopKeyPhrasesDetectionJob -> ()

Eq StopKeyPhrasesDetectionJob

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Methods

(==) :: StopKeyPhrasesDetectionJob -> StopKeyPhrasesDetectionJob -> Bool

(/=) :: StopKeyPhrasesDetectionJob -> StopKeyPhrasesDetectionJob -> Bool

Hashable StopKeyPhrasesDetectionJob

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Methods

hashWithSalt :: Int -> StopKeyPhrasesDetectionJob -> Int

hash :: StopKeyPhrasesDetectionJob -> Int

type AWSResponse StopKeyPhrasesDetectionJob

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

type AWSResponse StopKeyPhrasesDetectionJob = StopKeyPhrasesDetectionJobResponse

type Rep StopKeyPhrasesDetectionJob

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

Arguments

:: Text

StopKeyPhrasesDetectionJob

-> StopKeyPhrasesDetectionJob

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

The identifier of the key phrases detection job to stop.

Destructuring the Response

data StopKeyPhrasesDetectionJobResponse

See: newStopKeyPhrasesDetectionJobResponse smart constructor.

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

Generic StopKeyPhrasesDetectionJobResponse

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Associated Types

type Rep StopKeyPhrasesDetectionJobResponse :: Type -> Type

Methods

from :: StopKeyPhrasesDetectionJobResponse -> Rep StopKeyPhrasesDetectionJobResponse x

to :: Rep StopKeyPhrasesDetectionJobResponse x -> StopKeyPhrasesDetectionJobResponse

Read StopKeyPhrasesDetectionJobResponse

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Methods

readsPrec :: Int -> ReadS StopKeyPhrasesDetectionJobResponse

readList :: ReadS [StopKeyPhrasesDetectionJobResponse]

readPrec :: ReadPrec StopKeyPhrasesDetectionJobResponse

readListPrec :: ReadPrec [StopKeyPhrasesDetectionJobResponse]

Show StopKeyPhrasesDetectionJobResponse

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Methods

showsPrec :: Int -> StopKeyPhrasesDetectionJobResponse -> ShowS

show :: StopKeyPhrasesDetectionJobResponse -> String

showList :: [StopKeyPhrasesDetectionJobResponse] -> ShowS

NFData StopKeyPhrasesDetectionJobResponse

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Methods

rnf :: StopKeyPhrasesDetectionJobResponse -> ()

Eq StopKeyPhrasesDetectionJobResponse

Defined in Amazonka.Comprehend.StopKeyPhrasesDetectionJob

Methods

(==) :: StopKeyPhrasesDetectionJobResponse -> StopKeyPhrasesDetectionJobResponse -> Bool

(/=) :: StopKeyPhrasesDetectionJobResponse -> StopKeyPhrasesDetectionJobResponse -> Bool

type Rep StopKeyPhrasesDetectionJobResponse

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

Arguments

:: Int

$sel:httpStatus:StopKeyPhrasesDetectionJobResponse'

-> StopKeyPhrasesDetectionJobResponse

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)

The identifier of the key phrases detection job to stop.

stopKeyPhrasesDetectionJobResponse_jobStatus :: Lens' StopKeyPhrasesDetectionJobResponse (Maybe JobStatus)

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

stopKeyPhrasesDetectionJobResponse_httpStatus :: Lens' StopKeyPhrasesDetectionJobResponse Int

The response's http status code.