Amazonka.MediaConvert.UpdateQueue

Modify one of your existing queues.

Creating a Request

data UpdateQueue

See: newUpdateQueue smart constructor.

Constructors

UpdateQueue'

Fields

• 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.

• 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.

• name :: Text

  The name of the queue that you are modifying.

Instances

ToJSON UpdateQueue

Defined in Amazonka.MediaConvert.UpdateQueue

Methods

toJSON :: UpdateQueue -> Value

toEncoding :: UpdateQueue -> Encoding

toJSONList :: [UpdateQueue] -> Value

toEncodingList :: [UpdateQueue] -> Encoding

ToHeaders UpdateQueue

Defined in Amazonka.MediaConvert.UpdateQueue

Methods

toHeaders :: UpdateQueue -> [Header]

ToPath UpdateQueue

Defined in Amazonka.MediaConvert.UpdateQueue

Methods

toPath :: UpdateQueue -> ByteString

ToQuery UpdateQueue

Defined in Amazonka.MediaConvert.UpdateQueue

Methods

toQuery :: UpdateQueue -> QueryString

AWSRequest UpdateQueue

Defined in Amazonka.MediaConvert.UpdateQueue

Associated Types

type AWSResponse UpdateQueue

Methods

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

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

Generic UpdateQueue

Defined in Amazonka.MediaConvert.UpdateQueue

Associated Types

type Rep UpdateQueue :: Type -> Type

Methods

from :: UpdateQueue -> Rep UpdateQueue x

to :: Rep UpdateQueue x -> UpdateQueue

Read UpdateQueue

Defined in Amazonka.MediaConvert.UpdateQueue

Methods

readsPrec :: Int -> ReadS UpdateQueue

readList :: ReadS [UpdateQueue]

readPrec :: ReadPrec UpdateQueue

readListPrec :: ReadPrec [UpdateQueue]

Show UpdateQueue

Defined in Amazonka.MediaConvert.UpdateQueue

Methods

showsPrec :: Int -> UpdateQueue -> ShowS

show :: UpdateQueue -> String

showList :: [UpdateQueue] -> ShowS

NFData UpdateQueue

Defined in Amazonka.MediaConvert.UpdateQueue

Methods

rnf :: UpdateQueue -> ()

Eq UpdateQueue

Defined in Amazonka.MediaConvert.UpdateQueue

Methods

(==) :: UpdateQueue -> UpdateQueue -> Bool

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

Hashable UpdateQueue

Defined in Amazonka.MediaConvert.UpdateQueue

Methods

hashWithSalt :: Int -> UpdateQueue -> Int

hash :: UpdateQueue -> Int

type AWSResponse UpdateQueue

Defined in Amazonka.MediaConvert.UpdateQueue

type AWSResponse UpdateQueue = UpdateQueueResponse

type Rep UpdateQueue

Defined in Amazonka.MediaConvert.UpdateQueue

type Rep UpdateQueue = D1 ('MetaData "UpdateQueue" "Amazonka.MediaConvert.UpdateQueue" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" 'False) (C1 ('MetaCons "UpdateQueue'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "reservationPlanSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReservationPlanSettings))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueueStatus)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateQueue

Arguments

:: Text

UpdateQueue

-> UpdateQueue

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:

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.

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.

UpdateQueue, updateQueue_name - The name of the queue that you are modifying.

Request Lenses

updateQueue_description :: Lens' UpdateQueue (Maybe Text)

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

updateQueue_reservationPlanSettings :: Lens' UpdateQueue (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.

updateQueue_status :: Lens' UpdateQueue (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.

updateQueue_name :: Lens' UpdateQueue Text

The name of the queue that you are modifying.

Destructuring the Response

data UpdateQueueResponse

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

Generic UpdateQueueResponse

Defined in Amazonka.MediaConvert.UpdateQueue

Associated Types

type Rep UpdateQueueResponse :: Type -> Type

Methods

from :: UpdateQueueResponse -> Rep UpdateQueueResponse x

to :: Rep UpdateQueueResponse x -> UpdateQueueResponse

Read UpdateQueueResponse

Defined in Amazonka.MediaConvert.UpdateQueue

Methods

readsPrec :: Int -> ReadS UpdateQueueResponse

readList :: ReadS [UpdateQueueResponse]

readPrec :: ReadPrec UpdateQueueResponse

readListPrec :: ReadPrec [UpdateQueueResponse]

Show UpdateQueueResponse

Defined in Amazonka.MediaConvert.UpdateQueue

Methods

showsPrec :: Int -> UpdateQueueResponse -> ShowS

show :: UpdateQueueResponse -> String

showList :: [UpdateQueueResponse] -> ShowS

NFData UpdateQueueResponse

Defined in Amazonka.MediaConvert.UpdateQueue

Methods

rnf :: UpdateQueueResponse -> ()

Eq UpdateQueueResponse

Defined in Amazonka.MediaConvert.UpdateQueue

Methods

(==) :: UpdateQueueResponse -> UpdateQueueResponse -> Bool

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

type Rep UpdateQueueResponse

Defined in Amazonka.MediaConvert.UpdateQueue

type Rep UpdateQueueResponse = D1 ('MetaData "UpdateQueueResponse" "Amazonka.MediaConvert.UpdateQueue" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" '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

Arguments

:: Int

$sel:httpStatus:UpdateQueueResponse'

-> UpdateQueueResponse

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:

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)

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.

updateQueueResponse_httpStatus :: Lens' UpdateQueueResponse Int

The response's http status code.