libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert
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.MediaConvert.UpdateQueue

Description

Modify one of your existing queues.

Synopsis

Creating a Request

data UpdateQueue Source #

See: newUpdateQueue smart constructor.

Constructors

UpdateQueue' 

Fields

  • status :: Maybe QueueStatus

    Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or result in an error.

  • description :: Maybe Text

    The new description for the queue, if you are changing it.

  • reservationPlanSettings :: Maybe ReservationPlanSettings

    The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace an expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing the number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you make these commitments, you can't cancel them.

  • name :: Text

    The name of the queue that you are modifying.

Instances

Instances details
Eq UpdateQueue Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

Read UpdateQueue Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

Show UpdateQueue Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

Generic UpdateQueue Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

Associated Types

type Rep UpdateQueue :: Type -> Type #

NFData UpdateQueue Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

Methods

rnf :: UpdateQueue -> () #

Hashable UpdateQueue Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

ToJSON UpdateQueue Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

AWSRequest UpdateQueue Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

Associated Types

type AWSResponse UpdateQueue #

ToHeaders UpdateQueue Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

Methods

toHeaders :: UpdateQueue -> [Header] #

ToPath UpdateQueue Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

ToQuery UpdateQueue Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

type Rep UpdateQueue Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

type Rep UpdateQueue = D1 ('MetaData "UpdateQueue" "Amazonka.MediaConvert.UpdateQueue" "libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert" 'False) (C1 ('MetaCons "UpdateQueue'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueueStatus)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "reservationPlanSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReservationPlanSettings)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateQueue Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

newUpdateQueue Source #

Create a value of UpdateQueue 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:status:UpdateQueue', updateQueue_status - Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or result in an error.

$sel:description:UpdateQueue', updateQueue_description - The new description for the queue, if you are changing it.

$sel:reservationPlanSettings:UpdateQueue', updateQueue_reservationPlanSettings - The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace an expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing the number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you make these commitments, you can't cancel them.

$sel:name:UpdateQueue', updateQueue_name - The name of the queue that you are modifying.

Request Lenses

updateQueue_status :: Lens' UpdateQueue (Maybe QueueStatus) Source #

Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or result in an error.

updateQueue_description :: Lens' UpdateQueue (Maybe Text) Source #

The new description for the queue, if you are changing it.

updateQueue_reservationPlanSettings :: Lens' UpdateQueue (Maybe ReservationPlanSettings) Source #

The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace an expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing the number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you make these commitments, you can't cancel them.

updateQueue_name :: Lens' UpdateQueue Text Source #

The name of the queue that you are modifying.

Destructuring the Response

data UpdateQueueResponse Source #

See: newUpdateQueueResponse smart constructor.

Constructors

UpdateQueueResponse' 

Fields

  • queue :: Maybe Queue

    You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq UpdateQueueResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

Read UpdateQueueResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

Show UpdateQueueResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

Generic UpdateQueueResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

Associated Types

type Rep UpdateQueueResponse :: Type -> Type #

NFData UpdateQueueResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

Methods

rnf :: UpdateQueueResponse -> () #

type Rep UpdateQueueResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.UpdateQueue

type Rep UpdateQueueResponse = D1 ('MetaData "UpdateQueueResponse" "Amazonka.MediaConvert.UpdateQueue" "libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert" 'False) (C1 ('MetaCons "UpdateQueueResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Queue)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateQueueResponse Source #

Create a value of UpdateQueueResponse 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:queue:UpdateQueueResponse', updateQueueResponse_queue - You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.

$sel:httpStatus:UpdateQueueResponse', updateQueueResponse_httpStatus - The response's http status code.

Response Lenses

updateQueueResponse_queue :: Lens' UpdateQueueResponse (Maybe Queue) Source #

You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.