Amazonka.Comprehend.StopEntitiesDetectionJob

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.

Creating a Request

data StopEntitiesDetectionJob

See: newStopEntitiesDetectionJob smart constructor.

Constructors

StopEntitiesDetectionJob'

Fields

• jobId :: Text

  The identifier of the entities detection job to stop.

Instances

ToJSON StopEntitiesDetectionJob

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Methods

toJSON :: StopEntitiesDetectionJob -> Value

toEncoding :: StopEntitiesDetectionJob -> Encoding

toJSONList :: [StopEntitiesDetectionJob] -> Value

toEncodingList :: [StopEntitiesDetectionJob] -> Encoding

ToHeaders StopEntitiesDetectionJob

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Methods

toHeaders :: StopEntitiesDetectionJob -> [Header]

ToPath StopEntitiesDetectionJob

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Methods

toPath :: StopEntitiesDetectionJob -> ByteString

ToQuery StopEntitiesDetectionJob

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Methods

toQuery :: StopEntitiesDetectionJob -> QueryString

AWSRequest StopEntitiesDetectionJob

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Associated Types

type AWSResponse StopEntitiesDetectionJob

Methods

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

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

Generic StopEntitiesDetectionJob

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Associated Types

type Rep StopEntitiesDetectionJob :: Type -> Type

Methods

from :: StopEntitiesDetectionJob -> Rep StopEntitiesDetectionJob x

to :: Rep StopEntitiesDetectionJob x -> StopEntitiesDetectionJob

Read StopEntitiesDetectionJob

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Methods

readsPrec :: Int -> ReadS StopEntitiesDetectionJob

readList :: ReadS [StopEntitiesDetectionJob]

readPrec :: ReadPrec StopEntitiesDetectionJob

readListPrec :: ReadPrec [StopEntitiesDetectionJob]

Show StopEntitiesDetectionJob

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Methods

showsPrec :: Int -> StopEntitiesDetectionJob -> ShowS

show :: StopEntitiesDetectionJob -> String

showList :: [StopEntitiesDetectionJob] -> ShowS

NFData StopEntitiesDetectionJob

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Methods

rnf :: StopEntitiesDetectionJob -> ()

Eq StopEntitiesDetectionJob

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Methods

(==) :: StopEntitiesDetectionJob -> StopEntitiesDetectionJob -> Bool

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

Hashable StopEntitiesDetectionJob

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Methods

hashWithSalt :: Int -> StopEntitiesDetectionJob -> Int

hash :: StopEntitiesDetectionJob -> Int

type AWSResponse StopEntitiesDetectionJob

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

type AWSResponse StopEntitiesDetectionJob = StopEntitiesDetectionJobResponse

type Rep StopEntitiesDetectionJob

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

Arguments

:: Text

StopEntitiesDetectionJob

-> StopEntitiesDetectionJob

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

The identifier of the entities detection job to stop.

Destructuring the Response

data StopEntitiesDetectionJobResponse

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

Generic StopEntitiesDetectionJobResponse

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Associated Types

type Rep StopEntitiesDetectionJobResponse :: Type -> Type

Methods

from :: StopEntitiesDetectionJobResponse -> Rep StopEntitiesDetectionJobResponse x

to :: Rep StopEntitiesDetectionJobResponse x -> StopEntitiesDetectionJobResponse

Read StopEntitiesDetectionJobResponse

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Methods

readsPrec :: Int -> ReadS StopEntitiesDetectionJobResponse

readList :: ReadS [StopEntitiesDetectionJobResponse]

readPrec :: ReadPrec StopEntitiesDetectionJobResponse

readListPrec :: ReadPrec [StopEntitiesDetectionJobResponse]

Show StopEntitiesDetectionJobResponse

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Methods

showsPrec :: Int -> StopEntitiesDetectionJobResponse -> ShowS

show :: StopEntitiesDetectionJobResponse -> String

showList :: [StopEntitiesDetectionJobResponse] -> ShowS

NFData StopEntitiesDetectionJobResponse

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Methods

rnf :: StopEntitiesDetectionJobResponse -> ()

Eq StopEntitiesDetectionJobResponse

Defined in Amazonka.Comprehend.StopEntitiesDetectionJob

Methods

(==) :: StopEntitiesDetectionJobResponse -> StopEntitiesDetectionJobResponse -> Bool

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

type Rep StopEntitiesDetectionJobResponse

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

Arguments

:: Int

$sel:httpStatus:StopEntitiesDetectionJobResponse'

-> StopEntitiesDetectionJobResponse

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)

The identifier of the entities detection job to stop.

stopEntitiesDetectionJobResponse_jobStatus :: Lens' StopEntitiesDetectionJobResponse (Maybe JobStatus)

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

stopEntitiesDetectionJobResponse_httpStatus :: Lens' StopEntitiesDetectionJobResponse Int

The response's http status code.