libZSservicesZSamazonka-comprehendZSamazonka-comprehend
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Comprehend.StopDominantLanguageDetectionJob

Description

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.

Synopsis

Creating a Request

data StopDominantLanguageDetectionJob Source #

See: newStopDominantLanguageDetectionJob smart constructor.

Constructors

StopDominantLanguageDetectionJob' 

Fields

  • jobId :: Text

    The identifier of the dominant language detection job to stop.

Instances

Instances details
Eq StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

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

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

Read StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

readsPrec :: Int -> ReadS StopDominantLanguageDetectionJob #

readList :: ReadS [StopDominantLanguageDetectionJob] #

readPrec :: ReadPrec StopDominantLanguageDetectionJob #

readListPrec :: ReadPrec [StopDominantLanguageDetectionJob] #

Show StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

showsPrec :: Int -> StopDominantLanguageDetectionJob -> ShowS #

show :: StopDominantLanguageDetectionJob -> String #

showList :: [StopDominantLanguageDetectionJob] -> ShowS #

Generic StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Associated Types

type Rep StopDominantLanguageDetectionJob :: Type -> Type #

Methods

from :: StopDominantLanguageDetectionJob -> Rep StopDominantLanguageDetectionJob x #

to :: Rep StopDominantLanguageDetectionJob x -> StopDominantLanguageDetectionJob #

NFData StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

rnf :: StopDominantLanguageDetectionJob -> () #

Hashable StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

hashWithSalt :: Int -> StopDominantLanguageDetectionJob -> Int #

hash :: StopDominantLanguageDetectionJob -> Int #

ToJSON StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

toJSON :: StopDominantLanguageDetectionJob -> Value #

toEncoding :: StopDominantLanguageDetectionJob -> Encoding #

toJSONList :: [StopDominantLanguageDetectionJob] -> Value #

toEncodingList :: [StopDominantLanguageDetectionJob] -> Encoding #

AWSRequest StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Associated Types

type AWSResponse StopDominantLanguageDetectionJob #

Methods

request :: StopDominantLanguageDetectionJob -> Request StopDominantLanguageDetectionJob #

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

ToHeaders StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

toHeaders :: StopDominantLanguageDetectionJob -> [Header] #

ToPath StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

toPath :: StopDominantLanguageDetectionJob -> ByteString #

ToQuery StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

toQuery :: StopDominantLanguageDetectionJob -> QueryString #

type Rep StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

type Rep StopDominantLanguageDetectionJob = D1 ('MetaData "StopDominantLanguageDetectionJob" "Amazonka.Comprehend.StopDominantLanguageDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "StopDominantLanguageDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StopDominantLanguageDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

type AWSResponse StopDominantLanguageDetectionJob = StopDominantLanguageDetectionJobResponse

newStopDominantLanguageDetectionJob Source #

Arguments

:: Text

$sel:jobId: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:

$sel:jobId:StopDominantLanguageDetectionJob', stopDominantLanguageDetectionJob_jobId - The identifier of the dominant language detection job to stop.

Request Lenses

stopDominantLanguageDetectionJob_jobId :: Lens' StopDominantLanguageDetectionJob Text Source #

The identifier of the dominant language detection job to stop.

Destructuring the Response

data StopDominantLanguageDetectionJobResponse Source #

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

Instances details
Eq StopDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

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

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

Read StopDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

readsPrec :: Int -> ReadS StopDominantLanguageDetectionJobResponse #

readList :: ReadS [StopDominantLanguageDetectionJobResponse] #

readPrec :: ReadPrec StopDominantLanguageDetectionJobResponse #

readListPrec :: ReadPrec [StopDominantLanguageDetectionJobResponse] #

Show StopDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

showsPrec :: Int -> StopDominantLanguageDetectionJobResponse -> ShowS #

show :: StopDominantLanguageDetectionJobResponse -> String #

showList :: [StopDominantLanguageDetectionJobResponse] -> ShowS #

Generic StopDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Associated Types

type Rep StopDominantLanguageDetectionJobResponse :: Type -> Type #

Methods

from :: StopDominantLanguageDetectionJobResponse -> Rep StopDominantLanguageDetectionJobResponse x #

to :: Rep StopDominantLanguageDetectionJobResponse x -> StopDominantLanguageDetectionJobResponse #

NFData StopDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

Methods

rnf :: StopDominantLanguageDetectionJobResponse -> () #

type Rep StopDominantLanguageDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StopDominantLanguageDetectionJob

type Rep StopDominantLanguageDetectionJobResponse = D1 ('MetaData "StopDominantLanguageDetectionJobResponse" "Amazonka.Comprehend.StopDominantLanguageDetectionJob" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" '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 Source #

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:

$sel:jobId:StopDominantLanguageDetectionJob', stopDominantLanguageDetectionJobResponse_jobId - The identifier of the dominant language detection job to stop.

$sel:jobStatus: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) Source #

The identifier of the dominant language detection job to stop.

stopDominantLanguageDetectionJobResponse_jobStatus :: Lens' StopDominantLanguageDetectionJobResponse (Maybe JobStatus) Source #

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 Source #

The response's http status code.