Skip to content

/AWS1/IF_MDC=>CREATEQUEUE()

About CreateQueue

Create a new transcoding queue. For information about queues, see Working With Queues in the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html

Method Signature

METHODS /AWS1/IF_MDC~CREATEQUEUE
  IMPORTING
    !IV_CONCURRENTJOBS TYPE /AWS1/MDC__INTEGER OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/MDC__STRING OPTIONAL
    !IV_NAME TYPE /AWS1/MDC__STRING OPTIONAL
    !IV_PRICINGPLAN TYPE /AWS1/MDCPRICINGPLAN OPTIONAL
    !IO_RESERVATIONPLANSETTINGS TYPE REF TO /AWS1/CL_MDCRESERVATIONPLANS00 OPTIONAL
    !IV_STATUS TYPE /AWS1/MDCQUEUESTATUS OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_MDC__MAPOF__STRING_W=>TT___MAPOF__STRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mdccreatequeuersp
  RAISING
    /AWS1/CX_MDCBADREQUESTEX
    /AWS1/CX_MDCCONFLICTEXCEPTION
    /AWS1/CX_MDCFORBIDDENEXCEPTION
    /AWS1/CX_MDCINTERNALSERVERER00
    /AWS1/CX_MDCNOTFOUNDEXCEPTION
    /AWS1/CX_MDCSERVICEQUOTAEXCDEX
    /AWS1/CX_MDCTOOMANYREQUESTSEX
    /AWS1/CX_MDCCLIENTEXC
    /AWS1/CX_MDCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_name TYPE /AWS1/MDC__STRING /AWS1/MDC__STRING

The name of the queue that you are creating.

Optional arguments:

iv_concurrentjobs TYPE /AWS1/MDC__INTEGER /AWS1/MDC__INTEGER

Specify the maximum number of jobs your queue can process concurrently. For on-demand queues, the value you enter is constrained by your service quotas for Maximum concurrent jobs, per on-demand queue and Maximum concurrent jobs, per account. For reserved queues, specify the number of jobs you can process concurrently in your reservation plan instead.

iv_description TYPE /AWS1/MDC__STRING /AWS1/MDC__STRING

Optional. A description of the queue that you are creating.

iv_pricingplan TYPE /AWS1/MDCPRICINGPLAN /AWS1/MDCPRICINGPLAN

Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment. When you use the API to create a queue, the default is on-demand.

io_reservationplansettings TYPE REF TO /AWS1/CL_MDCRESERVATIONPLANS00 /AWS1/CL_MDCRESERVATIONPLANS00

Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.

iv_status TYPE /AWS1/MDCQUEUESTATUS /AWS1/MDCQUEUESTATUS

Initial state of the queue. If you create a paused queue, then jobs in that queue won't begin.

it_tags TYPE /AWS1/CL_MDC__MAPOF__STRING_W=>TT___MAPOF__STRING TT___MAPOF__STRING

The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.

RETURNING

oo_output TYPE REF TO /aws1/cl_mdccreatequeuersp /AWS1/CL_MDCCREATEQUEUERSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createqueue(
  io_reservationplansettings = new /aws1/cl_mdcreservationplans00(
    iv_commitment = |string|
    iv_renewaltype = |string|
    iv_reservedslots = 123
  )
  it_tags = VALUE /aws1/cl_mdc__mapof__string_w=>tt___mapof__string(
    (
      VALUE /aws1/cl_mdc__mapof__string_w=>ts___mapof__string_maprow(
        value = new /aws1/cl_mdc__mapof__string_w( |string| )
        key = |string|
      )
    )
  )
  iv_concurrentjobs = 123
  iv_description = |string|
  iv_name = |string|
  iv_pricingplan = |string|
  iv_status = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_queue = lo_result->get_queue( ).
  IF lo_queue IS NOT INITIAL.
    lv___string = lo_queue->get_arn( ).
    lv___integer = lo_queue->get_concurrentjobs( ).
    lv___timestampunix = lo_queue->get_createdat( ).
    lv___string = lo_queue->get_description( ).
    lv___timestampunix = lo_queue->get_lastupdated( ).
    lv___string = lo_queue->get_name( ).
    lv_pricingplan = lo_queue->get_pricingplan( ).
    lv___integer = lo_queue->get_progressingjobscount( ).
    lo_reservationplan = lo_queue->get_reservationplan( ).
    IF lo_reservationplan IS NOT INITIAL.
      lv_commitment = lo_reservationplan->get_commitment( ).
      lv___timestampunix = lo_reservationplan->get_expiresat( ).
      lv___timestampunix = lo_reservationplan->get_purchasedat( ).
      lv_renewaltype = lo_reservationplan->get_renewaltype( ).
      lv___integer = lo_reservationplan->get_reservedslots( ).
      lv_reservationplanstatus = lo_reservationplan->get_status( ).
    ENDIF.
    LOOP AT lo_queue->get_serviceoverrides( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv___string = lo_row_1->get_message( ).
        lv___string = lo_row_1->get_name( ).
        lv___string = lo_row_1->get_overridevalue( ).
        lv___string = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_queuestatus = lo_queue->get_status( ).
    lv___integer = lo_queue->get_submittedjobscount( ).
    lv_type = lo_queue->get_type( ).
  ENDIF.
ENDIF.