Amazonka.Comprehend.StopDominantLanguageDetectionJob

Stops a dominant language 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 StopDominantLanguageDetectionJob

See: newStopDominantLanguageDetectionJob smart constructor.

Constructors

StopDominantLanguageDetectionJob'

Fields

• jobId :: Text

  The identifier of the dominant language detection job to stop.

Instances

ToJSON StopDominantLanguageDetectionJob

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

toJSON :: StopDominantLanguageDetectionJob -> Value

toEncoding :: StopDominantLanguageDetectionJob -> Encoding

toJSONList :: [StopDominantLanguageDetectionJob] -> Value

toEncodingList :: [StopDominantLanguageDetectionJob] -> Encoding

ToHeaders StopDominantLanguageDetectionJob

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

toHeaders :: StopDominantLanguageDetectionJob -> [Header]

ToPath StopDominantLanguageDetectionJob

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

toPath :: StopDominantLanguageDetectionJob -> ByteString

ToQuery StopDominantLanguageDetectionJob

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

toQuery :: StopDominantLanguageDetectionJob -> QueryString

AWSRequest StopDominantLanguageDetectionJob

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Associated Types

type AWSResponse StopDominantLanguageDetectionJob

Methods

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

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

Generic StopDominantLanguageDetectionJob

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Associated Types

type Rep StopDominantLanguageDetectionJob :: Type -> Type

Methods

from :: StopDominantLanguageDetectionJob -> Rep StopDominantLanguageDetectionJob x

to :: Rep StopDominantLanguageDetectionJob x -> StopDominantLanguageDetectionJob

Read StopDominantLanguageDetectionJob

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

readsPrec :: Int -> ReadS StopDominantLanguageDetectionJob

readList :: ReadS [StopDominantLanguageDetectionJob]

readPrec :: ReadPrec StopDominantLanguageDetectionJob

readListPrec :: ReadPrec [StopDominantLanguageDetectionJob]

Show StopDominantLanguageDetectionJob

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

showsPrec :: Int -> StopDominantLanguageDetectionJob -> ShowS

show :: StopDominantLanguageDetectionJob -> String

showList :: [StopDominantLanguageDetectionJob] -> ShowS

NFData StopDominantLanguageDetectionJob

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

rnf :: StopDominantLanguageDetectionJob -> ()

Eq StopDominantLanguageDetectionJob

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

(==) :: StopDominantLanguageDetectionJob -> StopDominantLanguageDetectionJob -> Bool

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

Hashable StopDominantLanguageDetectionJob

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

hashWithSalt :: Int -> StopDominantLanguageDetectionJob -> Int

hash :: StopDominantLanguageDetectionJob -> Int

type AWSResponse StopDominantLanguageDetectionJob

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

type AWSResponse StopDominantLanguageDetectionJob = StopDominantLanguageDetectionJobResponse

type Rep StopDominantLanguageDetectionJob

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

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

newStopDominantLanguageDetectionJob

Arguments

:: Text

StopDominantLanguageDetectionJob

-> StopDominantLanguageDetectionJob

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

StopDominantLanguageDetectionJob, stopDominantLanguageDetectionJob_jobId - The identifier of the dominant language detection job to stop.

Request Lenses

stopDominantLanguageDetectionJob_jobId :: Lens' StopDominantLanguageDetectionJob Text

The identifier of the dominant language detection job to stop.

Destructuring the Response

data StopDominantLanguageDetectionJobResponse

See: newStopDominantLanguageDetectionJobResponse smart constructor.

Constructors

StopDominantLanguageDetectionJobResponse'

Fields

• jobId :: Maybe Text

  The identifier of the dominant language 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 StopDominantLanguageDetectionJob operation.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StopDominantLanguageDetectionJobResponse

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Associated Types

type Rep StopDominantLanguageDetectionJobResponse :: Type -> Type

Methods

from :: StopDominantLanguageDetectionJobResponse -> Rep StopDominantLanguageDetectionJobResponse x

to :: Rep StopDominantLanguageDetectionJobResponse x -> StopDominantLanguageDetectionJobResponse

Read StopDominantLanguageDetectionJobResponse

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

readsPrec :: Int -> ReadS StopDominantLanguageDetectionJobResponse

readList :: ReadS [StopDominantLanguageDetectionJobResponse]

readPrec :: ReadPrec StopDominantLanguageDetectionJobResponse

readListPrec :: ReadPrec [StopDominantLanguageDetectionJobResponse]

Show StopDominantLanguageDetectionJobResponse

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

showsPrec :: Int -> StopDominantLanguageDetectionJobResponse -> ShowS

show :: StopDominantLanguageDetectionJobResponse -> String

showList :: [StopDominantLanguageDetectionJobResponse] -> ShowS

NFData StopDominantLanguageDetectionJobResponse

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

rnf :: StopDominantLanguageDetectionJobResponse -> ()

Eq StopDominantLanguageDetectionJobResponse

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

(==) :: StopDominantLanguageDetectionJobResponse -> StopDominantLanguageDetectionJobResponse -> Bool

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

type Rep StopDominantLanguageDetectionJobResponse

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

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

newStopDominantLanguageDetectionJobResponse

Arguments

:: Int

$sel:httpStatus:StopDominantLanguageDetectionJobResponse'

-> StopDominantLanguageDetectionJobResponse

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

StopDominantLanguageDetectionJob, stopDominantLanguageDetectionJobResponse_jobId - The identifier of the dominant language detection job to stop.

StopDominantLanguageDetectionJobResponse, stopDominantLanguageDetectionJobResponse_jobStatus - Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopDominantLanguageDetectionJob operation.

$sel:httpStatus:StopDominantLanguageDetectionJobResponse', stopDominantLanguageDetectionJobResponse_httpStatus - The response's http status code.

Response Lenses

stopDominantLanguageDetectionJobResponse_jobId :: Lens' StopDominantLanguageDetectionJobResponse (Maybe Text)

The identifier of the dominant language detection job to stop.

stopDominantLanguageDetectionJobResponse_jobStatus :: Lens' StopDominantLanguageDetectionJobResponse (Maybe JobStatus)

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

stopDominantLanguageDetectionJobResponse_httpStatus :: Lens' StopDominantLanguageDetectionJobResponse Int

The response's http status code.