libZSservicesZSamazonka-elastictranscoderZSamazonka-elastictranscoder
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.ElasticTranscoder.UpdatePipelineStatus

Description

The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs.

Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request.

Synopsis

Creating a Request

data UpdatePipelineStatus Source #

The UpdatePipelineStatusRequest structure.

See: newUpdatePipelineStatus smart constructor.

Constructors

UpdatePipelineStatus' 

Fields

  • id :: Text

    The identifier of the pipeline to update.

  • status :: Text

    The desired status of the pipeline:

    • Active: The pipeline is processing jobs.
    • Paused: The pipeline is not currently processing jobs.

Instances

Instances details
Eq UpdatePipelineStatus Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

Read UpdatePipelineStatus Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

Show UpdatePipelineStatus Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

Generic UpdatePipelineStatus Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

Associated Types

type Rep UpdatePipelineStatus :: Type -> Type #

NFData UpdatePipelineStatus Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

Methods

rnf :: UpdatePipelineStatus -> () #

Hashable UpdatePipelineStatus Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

ToJSON UpdatePipelineStatus Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

AWSRequest UpdatePipelineStatus Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

Associated Types

type AWSResponse UpdatePipelineStatus #

ToHeaders UpdatePipelineStatus Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

ToPath UpdatePipelineStatus Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

ToQuery UpdatePipelineStatus Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

type Rep UpdatePipelineStatus Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

type Rep UpdatePipelineStatus = D1 ('MetaData "UpdatePipelineStatus" "Amazonka.ElasticTranscoder.UpdatePipelineStatus" "libZSservicesZSamazonka-elastictranscoderZSamazonka-elastictranscoder" 'False) (C1 ('MetaCons "UpdatePipelineStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse UpdatePipelineStatus Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

newUpdatePipelineStatus Source #

Create a value of UpdatePipelineStatus 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:id:UpdatePipelineStatus', updatePipelineStatus_id - The identifier of the pipeline to update.

$sel:status:UpdatePipelineStatus', updatePipelineStatus_status - The desired status of the pipeline:

  • Active: The pipeline is processing jobs.
  • Paused: The pipeline is not currently processing jobs.

Request Lenses

updatePipelineStatus_id :: Lens' UpdatePipelineStatus Text Source #

The identifier of the pipeline to update.

updatePipelineStatus_status :: Lens' UpdatePipelineStatus Text Source #

The desired status of the pipeline:

  • Active: The pipeline is processing jobs.
  • Paused: The pipeline is not currently processing jobs.

Destructuring the Response

data UpdatePipelineStatusResponse Source #

When you update status for a pipeline, Elastic Transcoder returns the values that you specified in the request.

See: newUpdatePipelineStatusResponse smart constructor.

Constructors

UpdatePipelineStatusResponse' 

Fields

Instances

Instances details
Eq UpdatePipelineStatusResponse Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

Read UpdatePipelineStatusResponse Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

Show UpdatePipelineStatusResponse Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

Generic UpdatePipelineStatusResponse Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

Associated Types

type Rep UpdatePipelineStatusResponse :: Type -> Type #

NFData UpdatePipelineStatusResponse Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

type Rep UpdatePipelineStatusResponse Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineStatus

type Rep UpdatePipelineStatusResponse = D1 ('MetaData "UpdatePipelineStatusResponse" "Amazonka.ElasticTranscoder.UpdatePipelineStatus" "libZSservicesZSamazonka-elastictranscoderZSamazonka-elastictranscoder" 'False) (C1 ('MetaCons "UpdatePipelineStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipeline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Pipeline)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdatePipelineStatusResponse Source #

Create a value of UpdatePipelineStatusResponse 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:pipeline:UpdatePipelineStatusResponse', updatePipelineStatusResponse_pipeline - A section of the response body that provides information about the pipeline.

$sel:httpStatus:UpdatePipelineStatusResponse', updatePipelineStatusResponse_httpStatus - The response's http status code.

Response Lenses

updatePipelineStatusResponse_pipeline :: Lens' UpdatePipelineStatusResponse (Maybe Pipeline) Source #

A section of the response body that provides information about the pipeline.