Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Translate.StopTextTranslationJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stops an asynchronous batch translation job that is in progress.

If the job's state is IN_PROGRESS, the job will be 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 put into the STOPPED state.

Asynchronous batch translation jobs are started with the StartTextTranslationJob operation. You can use the DescribeTextTranslationJob or ListTextTranslationJobs operations to get a batch translation job's JobId.

Creating a Request

data StopTextTranslationJob Source #

See: newStopTextTranslationJob smart constructor.

Constructors

StopTextTranslationJob'
Fields jobId :: Text The job ID of the job to be stopped.

Instances

Instances details

ToJSON StopTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob Methods toJSON :: StopTextTranslationJob -> Value # toEncoding :: StopTextTranslationJob -> Encoding # toJSONList :: [StopTextTranslationJob] -> Value # toEncodingList :: [StopTextTranslationJob] -> Encoding #
ToHeaders StopTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob Methods toHeaders :: StopTextTranslationJob -> [Header] #
ToPath StopTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob Methods toPath :: StopTextTranslationJob -> ByteString #
ToQuery StopTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob Methods toQuery :: StopTextTranslationJob -> QueryString #
AWSRequest StopTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob Associated Types type AWSResponse StopTextTranslationJob # Methods request :: (Service -> Service) -> StopTextTranslationJob -> Request StopTextTranslationJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopTextTranslationJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopTextTranslationJob))) #
Generic StopTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob Associated Types type Rep StopTextTranslationJob :: Type -> Type # Methods from :: StopTextTranslationJob -> Rep StopTextTranslationJob x # to :: Rep StopTextTranslationJob x -> StopTextTranslationJob #
Read StopTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob Methods readsPrec :: Int -> ReadS StopTextTranslationJob # readList :: ReadS [StopTextTranslationJob] # readPrec :: ReadPrec StopTextTranslationJob # readListPrec :: ReadPrec [StopTextTranslationJob] #
Show StopTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob Methods showsPrec :: Int -> StopTextTranslationJob -> ShowS # show :: StopTextTranslationJob -> String # showList :: [StopTextTranslationJob] -> ShowS #
NFData StopTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob Methods rnf :: StopTextTranslationJob -> () #
Eq StopTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob Methods (==) :: StopTextTranslationJob -> StopTextTranslationJob -> Bool # (/=) :: StopTextTranslationJob -> StopTextTranslationJob -> Bool #
Hashable StopTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob Methods hashWithSalt :: Int -> StopTextTranslationJob -> Int # hash :: StopTextTranslationJob -> Int #
type AWSResponse StopTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob type AWSResponse StopTextTranslationJob = StopTextTranslationJobResponse
type Rep StopTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob type Rep StopTextTranslationJob = D1 ('MetaData "StopTextTranslationJob" "Amazonka.Translate.StopTextTranslationJob" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" 'False) (C1 ('MetaCons "StopTextTranslationJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopTextTranslationJob Source #

Arguments

:: Text	`StopTextTranslationJob`
-> StopTextTranslationJob

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

StopTextTranslationJob, stopTextTranslationJob_jobId - The job ID of the job to be stopped.

Request Lenses

stopTextTranslationJob_jobId :: Lens' StopTextTranslationJob Text Source #

The job ID of the job to be stopped.

Destructuring the Response

data StopTextTranslationJobResponse Source #

See: newStopTextTranslationJobResponse smart constructor.

Constructors

StopTextTranslationJobResponse'
Fields jobId :: Maybe Text The job ID of the stopped batch translation job. jobStatus :: Maybe JobStatus The status of the designated job. Upon successful completion, the job's status will be `STOPPED`. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic StopTextTranslationJobResponse Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob Associated Types type Rep StopTextTranslationJobResponse :: Type -> Type # Methods from :: StopTextTranslationJobResponse -> Rep StopTextTranslationJobResponse x # to :: Rep StopTextTranslationJobResponse x -> StopTextTranslationJobResponse #
Read StopTextTranslationJobResponse Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob Methods readsPrec :: Int -> ReadS StopTextTranslationJobResponse # readList :: ReadS [StopTextTranslationJobResponse] # readPrec :: ReadPrec StopTextTranslationJobResponse # readListPrec :: ReadPrec [StopTextTranslationJobResponse] #
Show StopTextTranslationJobResponse Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob Methods showsPrec :: Int -> StopTextTranslationJobResponse -> ShowS # show :: StopTextTranslationJobResponse -> String # showList :: [StopTextTranslationJobResponse] -> ShowS #
NFData StopTextTranslationJobResponse Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob Methods rnf :: StopTextTranslationJobResponse -> () #
Eq StopTextTranslationJobResponse Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob Methods (==) :: StopTextTranslationJobResponse -> StopTextTranslationJobResponse -> Bool # (/=) :: StopTextTranslationJobResponse -> StopTextTranslationJobResponse -> Bool #
type Rep StopTextTranslationJobResponse Source #
Instance details Defined in Amazonka.Translate.StopTextTranslationJob type Rep StopTextTranslationJobResponse = D1 ('MetaData "StopTextTranslationJobResponse" "Amazonka.Translate.StopTextTranslationJob" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" 'False) (C1 ('MetaCons "StopTextTranslationJobResponse'" '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))))

newStopTextTranslationJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:StopTextTranslationJobResponse'`
-> StopTextTranslationJobResponse

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

StopTextTranslationJob, stopTextTranslationJobResponse_jobId - The job ID of the stopped batch translation job.

StopTextTranslationJobResponse, stopTextTranslationJobResponse_jobStatus - The status of the designated job. Upon successful completion, the job's status will be STOPPED.

$sel:httpStatus:StopTextTranslationJobResponse', stopTextTranslationJobResponse_httpStatus - The response's http status code.

Response Lenses

stopTextTranslationJobResponse_jobId :: Lens' StopTextTranslationJobResponse (Maybe Text) Source #

The job ID of the stopped batch translation job.

stopTextTranslationJobResponse_jobStatus :: Lens' StopTextTranslationJobResponse (Maybe JobStatus) Source #

The status of the designated job. Upon successful completion, the job's status will be STOPPED.

stopTextTranslationJobResponse_httpStatus :: Lens' StopTextTranslationJobResponse Int Source #

The response's http status code.