Skip to content

/AWS1/IF_IMG=>UPDATEIMAGEPIPELINE()

About UpdateImagePipeline

Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images. You must specify exactly one recipe for your image, using either a containerRecipeArn or an imageRecipeArn.

UpdateImagePipeline does not support selective updates for the pipeline. You must specify all of the required properties in the update request, not just the properties that have changed.

Method Signature

METHODS /AWS1/IF_IMG~UPDATEIMAGEPIPELINE
  IMPORTING
    !IV_IMAGEPIPELINEARN TYPE /AWS1/IMGIMAGEPIPELINEARN OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/IMGNONEMPTYSTRING OPTIONAL
    !IV_IMAGERECIPEARN TYPE /AWS1/IMGIMAGERECIPEARN OPTIONAL
    !IV_CONTAINERRECIPEARN TYPE /AWS1/IMGCONTAINERRECIPEARN OPTIONAL
    !IV_INFRASTRUCTURECONFARN TYPE /AWS1/IMGINFRASTRUCTURECONFARN OPTIONAL
    !IV_DISTRIBUTIONCONFARN TYPE /AWS1/IMGDISTRIBUTIONCONFARN OPTIONAL
    !IO_IMAGETESTSCONFIGURATION TYPE REF TO /AWS1/CL_IMGIMAGETESTSCONF OPTIONAL
    !IV_ENHANCEDIMAGEMETENABLED TYPE /AWS1/IMGNULLABLEBOOLEAN OPTIONAL
    !IO_SCHEDULE TYPE REF TO /AWS1/CL_IMGSCHEDULE OPTIONAL
    !IV_STATUS TYPE /AWS1/IMGPIPELINESTATUS OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/IMGCLIENTTOKEN OPTIONAL
    !IO_IMAGESCANNINGCONF TYPE REF TO /AWS1/CL_IMGIMAGESCANNINGCONF OPTIONAL
    !IT_WORKFLOWS TYPE /AWS1/CL_IMGWORKFLOWCONF=>TT_WORKFLOWCONFIGURATIONLIST OPTIONAL
    !IO_LOGGINGCONFIGURATION TYPE REF TO /AWS1/CL_IMGPLINLOGGINGCONF OPTIONAL
    !IV_EXECUTIONROLE TYPE /AWS1/IMGROLENAMEORARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_imgupdateimageplinrsp
  RAISING
    /AWS1/CX_IMGCALLRLIMEXCEEDEDEX
    /AWS1/CX_IMGCLIENTEXCEPTION
    /AWS1/CX_IMGFORBIDDENEXCEPTION
    /AWS1/CX_IMGIDEMPOTENTPRMMIS00
    /AWS1/CX_IMGINVALIDREQUESTEX
    /AWS1/CX_IMGRESOURCEINUSEEX
    /AWS1/CX_IMGSERVICEEXCEPTION
    /AWS1/CX_IMGSERVICEUNAVAILEX
    /AWS1/CX_IMGCLIENTEXC
    /AWS1/CX_IMGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_imagepipelinearn TYPE /AWS1/IMGIMAGEPIPELINEARN /AWS1/IMGIMAGEPIPELINEARN

The Amazon Resource Name (ARN) of the image pipeline that you want to update.

iv_infrastructureconfarn TYPE /AWS1/IMGINFRASTRUCTURECONFARN /AWS1/IMGINFRASTRUCTURECONFARN

The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.

iv_clienttoken TYPE /AWS1/IMGCLIENTTOKEN /AWS1/IMGCLIENTTOKEN

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Optional arguments:

iv_description TYPE /AWS1/IMGNONEMPTYSTRING /AWS1/IMGNONEMPTYSTRING

The description of the image pipeline.

iv_imagerecipearn TYPE /AWS1/IMGIMAGERECIPEARN /AWS1/IMGIMAGERECIPEARN

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.

iv_containerrecipearn TYPE /AWS1/IMGCONTAINERRECIPEARN /AWS1/IMGCONTAINERRECIPEARN

The Amazon Resource Name (ARN) of the container pipeline to update.

iv_distributionconfarn TYPE /AWS1/IMGDISTRIBUTIONCONFARN /AWS1/IMGDISTRIBUTIONCONFARN

The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.

io_imagetestsconfiguration TYPE REF TO /AWS1/CL_IMGIMAGETESTSCONF /AWS1/CL_IMGIMAGETESTSCONF

The image test configuration of the image pipeline.

iv_enhancedimagemetenabled TYPE /AWS1/IMGNULLABLEBOOLEAN /AWS1/IMGNULLABLEBOOLEAN

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

io_schedule TYPE REF TO /AWS1/CL_IMGSCHEDULE /AWS1/CL_IMGSCHEDULE

The schedule of the image pipeline.

iv_status TYPE /AWS1/IMGPIPELINESTATUS /AWS1/IMGPIPELINESTATUS

The status of the image pipeline.

io_imagescanningconf TYPE REF TO /AWS1/CL_IMGIMAGESCANNINGCONF /AWS1/CL_IMGIMAGESCANNINGCONF

Contains settings for vulnerability scans.

it_workflows TYPE /AWS1/CL_IMGWORKFLOWCONF=>TT_WORKFLOWCONFIGURATIONLIST TT_WORKFLOWCONFIGURATIONLIST

Contains the workflows to run for the pipeline.

io_loggingconfiguration TYPE REF TO /AWS1/CL_IMGPLINLOGGINGCONF /AWS1/CL_IMGPLINLOGGINGCONF

Update logging configuration for the output image that's created when the pipeline runs.

iv_executionrole TYPE /AWS1/IMGROLENAMEORARN /AWS1/IMGROLENAMEORARN

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

RETURNING

oo_output TYPE REF TO /aws1/cl_imgupdateimageplinrsp /AWS1/CL_IMGUPDATEIMAGEPLINRSP

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->updateimagepipeline(
  io_imagescanningconf = new /aws1/cl_imgimagescanningconf(
    io_ecrconfiguration = new /aws1/cl_imgecrconfiguration(
      it_containertags = VALUE /aws1/cl_imgstringlist_w=>tt_stringlist(
        ( new /aws1/cl_imgstringlist_w( |string| ) )
      )
      iv_repositoryname = |string|
    )
    iv_imagescanningenabled = ABAP_TRUE
  )
  io_imagetestsconfiguration = new /aws1/cl_imgimagetestsconf(
    iv_imagetestsenabled = ABAP_TRUE
    iv_timeoutminutes = 123
  )
  io_loggingconfiguration = new /aws1/cl_imgplinloggingconf(
    iv_imageloggroupname = |string|
    iv_pipelineloggroupname = |string|
  )
  io_schedule = new /aws1/cl_imgschedule(
    io_autodisablepolicy = new /aws1/cl_imgautodisablepolicy( 123 )
    iv_pipelineexecstartcond = |string|
    iv_scheduleexpression = |string|
    iv_timezone = |string|
  )
  it_workflows = VALUE /aws1/cl_imgworkflowconf=>tt_workflowconfigurationlist(
    (
      new /aws1/cl_imgworkflowconf(
        it_parameters = VALUE /aws1/cl_imgworkflowparameter=>tt_workflowparameterlist(
          (
            new /aws1/cl_imgworkflowparameter(
              it_value = VALUE /aws1/cl_imgworkflowprmvalls00=>tt_workflowparametervaluelist(
                ( new /aws1/cl_imgworkflowprmvalls00( |string| ) )
              )
              iv_name = |string|
            )
          )
        )
        iv_onfailure = |string|
        iv_parallelgroup = |string|
        iv_workflowarn = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_containerrecipearn = |string|
  iv_description = |string|
  iv_distributionconfarn = |string|
  iv_enhancedimagemetenabled = ABAP_TRUE
  iv_executionrole = |string|
  iv_imagepipelinearn = |string|
  iv_imagerecipearn = |string|
  iv_infrastructureconfarn = |string|
  iv_status = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nonemptystring = lo_result->get_requestid( ).
  lv_clienttoken = lo_result->get_clienttoken( ).
  lv_imagepipelinearn = lo_result->get_imagepipelinearn( ).
ENDIF.