Skip to content

/AWS1/IF_ETC=>UPDATEPIPELINE()

About UpdatePipeline

Use the UpdatePipeline operation to update settings for a pipeline.

When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings.

Method Signature

METHODS /AWS1/IF_ETC~UPDATEPIPELINE
  IMPORTING
    !IV_ID TYPE /AWS1/ETCID OPTIONAL
    !IV_NAME TYPE /AWS1/ETCNAME OPTIONAL
    !IV_INPUTBUCKET TYPE /AWS1/ETCBUCKETNAME OPTIONAL
    !IV_ROLE TYPE /AWS1/ETCROLE OPTIONAL
    !IV_AWSKMSKEYARN TYPE /AWS1/ETCKEYARN OPTIONAL
    !IO_NOTIFICATIONS TYPE REF TO /AWS1/CL_ETCNOTIFICATIONS OPTIONAL
    !IO_CONTENTCONFIG TYPE REF TO /AWS1/CL_ETCPLINOUTPUTCONFIG OPTIONAL
    !IO_THUMBNAILCONFIG TYPE REF TO /AWS1/CL_ETCPLINOUTPUTCONFIG OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_etcupdateplinresponse
  RAISING
    /AWS1/CX_ETCACCESSDENIEDEX
    /AWS1/CX_ETCINCOMPATIBLEVRSEX
    /AWS1/CX_ETCINTERNALSERVICEEX
    /AWS1/CX_ETCRESOURCEINUSEEX
    /AWS1/CX_ETCRESOURCENOTFOUNDEX
    /AWS1/CX_ETCVALIDATIONEX
    /AWS1/CX_ETCCLIENTEXC
    /AWS1/CX_ETCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_id TYPE /AWS1/ETCID /AWS1/ETCID

The ID of the pipeline that you want to update.

Optional arguments:

iv_name TYPE /AWS1/ETCNAME /AWS1/ETCNAME

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

iv_inputbucket TYPE /AWS1/ETCBUCKETNAME /AWS1/ETCBUCKETNAME

The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want to use as watermarks.

iv_role TYPE /AWS1/ETCROLE /AWS1/ETCROLE

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for this pipeline.

iv_awskmskeyarn TYPE /AWS1/ETCKEYARN /AWS1/ETCKEYARN

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.

io_notifications TYPE REF TO /AWS1/CL_ETCNOTIFICATIONS /AWS1/CL_ETCNOTIFICATIONS

The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

  • Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

  • Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.

  • Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.

  • Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.

io_contentconfig TYPE REF TO /AWS1/CL_ETCPLINOUTPUTCONFIG /AWS1/CL_ETCPLINOUTPUTCONFIG

The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

  • Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

  • Grantee Type: Specify the type of value that appears in the Grantee object:

    • Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content.

      A canonical user ID is not the same as an AWS account number.

    • Email: The value in the Grantee object is the registered email address of an AWS account.

    • Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

  • Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group

  • Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include:

    • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

io_thumbnailconfig TYPE REF TO /AWS1/CL_ETCPLINOUTPUTCONFIG /AWS1/CL_ETCPLINOUTPUTCONFIG

The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig even if you don't want to create thumbnails.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

  • Permissions (Optional): The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

  • GranteeType: Specify the type of value that appears in the Grantee object:

    • Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

      A canonical user ID is not the same as an AWS account number.

    • Email: The value in the Grantee object is the registered email address of an AWS account.

    • Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

  • Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.

  • Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include:

    • READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

    • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

    • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

RETURNING

oo_output TYPE REF TO /aws1/cl_etcupdateplinresponse /AWS1/CL_ETCUPDATEPLINRESPONSE

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->updatepipeline(
  io_contentconfig = new /aws1/cl_etcplinoutputconfig(
    it_permissions = VALUE /aws1/cl_etcpermission=>tt_permissions(
      (
        new /aws1/cl_etcpermission(
          it_access = VALUE /aws1/cl_etcaccesscontrols_w=>tt_accesscontrols(
            ( new /aws1/cl_etcaccesscontrols_w( |string| ) )
          )
          iv_grantee = |string|
          iv_granteetype = |string|
        )
      )
    )
    iv_bucket = |string|
    iv_storageclass = |string|
  )
  io_notifications = new /aws1/cl_etcnotifications(
    iv_completed = |string|
    iv_error = |string|
    iv_progressing = |string|
    iv_warning = |string|
  )
  io_thumbnailconfig = new /aws1/cl_etcplinoutputconfig(
    it_permissions = VALUE /aws1/cl_etcpermission=>tt_permissions(
      (
        new /aws1/cl_etcpermission(
          it_access = VALUE /aws1/cl_etcaccesscontrols_w=>tt_accesscontrols(
            ( new /aws1/cl_etcaccesscontrols_w( |string| ) )
          )
          iv_grantee = |string|
          iv_granteetype = |string|
        )
      )
    )
    iv_bucket = |string|
    iv_storageclass = |string|
  )
  iv_awskmskeyarn = |string|
  iv_id = |string|
  iv_inputbucket = |string|
  iv_name = |string|
  iv_role = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_pipeline = lo_result->get_pipeline( ).
  IF lo_pipeline IS NOT INITIAL.
    lv_id = lo_pipeline->get_id( ).
    lv_string = lo_pipeline->get_arn( ).
    lv_name = lo_pipeline->get_name( ).
    lv_pipelinestatus = lo_pipeline->get_status( ).
    lv_bucketname = lo_pipeline->get_inputbucket( ).
    lv_bucketname = lo_pipeline->get_outputbucket( ).
    lv_role = lo_pipeline->get_role( ).
    lv_keyarn = lo_pipeline->get_awskmskeyarn( ).
    lo_notifications = lo_pipeline->get_notifications( ).
    IF lo_notifications IS NOT INITIAL.
      lv_snstopic = lo_notifications->get_progressing( ).
      lv_snstopic = lo_notifications->get_completed( ).
      lv_snstopic = lo_notifications->get_warning( ).
      lv_snstopic = lo_notifications->get_error( ).
    ENDIF.
    lo_pipelineoutputconfig = lo_pipeline->get_contentconfig( ).
    IF lo_pipelineoutputconfig IS NOT INITIAL.
      lv_bucketname = lo_pipelineoutputconfig->get_bucket( ).
      lv_storageclass = lo_pipelineoutputconfig->get_storageclass( ).
      LOOP AT lo_pipelineoutputconfig->get_permissions( ) into lo_row.
        lo_row_1 = lo_row.
        IF lo_row_1 IS NOT INITIAL.
          lv_granteetype = lo_row_1->get_granteetype( ).
          lv_grantee = lo_row_1->get_grantee( ).
          LOOP AT lo_row_1->get_access( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_accesscontrol = lo_row_3->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
    ENDIF.
    lo_pipelineoutputconfig = lo_pipeline->get_thumbnailconfig( ).
    IF lo_pipelineoutputconfig IS NOT INITIAL.
      lv_bucketname = lo_pipelineoutputconfig->get_bucket( ).
      lv_storageclass = lo_pipelineoutputconfig->get_storageclass( ).
      LOOP AT lo_pipelineoutputconfig->get_permissions( ) into lo_row.
        lo_row_1 = lo_row.
        IF lo_row_1 IS NOT INITIAL.
          lv_granteetype = lo_row_1->get_granteetype( ).
          lv_grantee = lo_row_1->get_grantee( ).
          LOOP AT lo_row_1->get_access( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_accesscontrol = lo_row_3->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDIF.
  LOOP AT lo_result->get_warnings( ) into lo_row_4.
    lo_row_5 = lo_row_4.
    IF lo_row_5 IS NOT INITIAL.
      lv_string = lo_row_5->get_code( ).
      lv_string = lo_row_5->get_message( ).
    ENDIF.
  ENDLOOP.
ENDIF.