Skip to content

/AWS1/IF_ECR=>GETLIFECYCLEPOLICYPREVIEW()

About GetLifecyclePolicyPreview

Retrieves the results of the lifecycle policy preview request for the specified repository.

Method Signature

METHODS /AWS1/IF_ECR~GETLIFECYCLEPOLICYPREVIEW
  IMPORTING
    !IV_REGISTRYID TYPE /AWS1/ECRREGISTRYID OPTIONAL
    !IV_REPOSITORYNAME TYPE /AWS1/ECRREPOSITORYNAME OPTIONAL
    !IT_IMAGEIDS TYPE /AWS1/CL_ECRIMAGEIDENTIFIER=>TT_IMAGEIDENTIFIERLIST OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ECRNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/ECRLCPREVIEWMAXRESULTS OPTIONAL
    !IO_FILTER TYPE REF TO /AWS1/CL_ECRLCPLYPREVIEWFILTER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ecrgetlcplypreviewrsp
  RAISING
    /AWS1/CX_ECRINVALIDPARAMETEREX
    /AWS1/CX_ECRLCPLYPREVIEWNOTF00
    /AWS1/CX_ECRREPOSITORYNOTFNDEX
    /AWS1/CX_ECRSERVEREXCEPTION
    /AWS1/CX_ECRVALIDATIONEX
    /AWS1/CX_ECRCLIENTEXC
    /AWS1/CX_ECRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_repositoryname TYPE /AWS1/ECRREPOSITORYNAME /AWS1/ECRREPOSITORYNAME

The name of the repository.

Optional arguments:

iv_registryid TYPE /AWS1/ECRREGISTRYID /AWS1/ECRREGISTRYID

The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

it_imageids TYPE /AWS1/CL_ECRIMAGEIDENTIFIER=>TT_IMAGEIDENTIFIERLIST TT_IMAGEIDENTIFIERLIST

The list of imageIDs to be included.

iv_nexttoken TYPE /AWS1/ECRNEXTTOKEN /AWS1/ECRNEXTTOKEN

The nextToken value returned from a previous paginated
 GetLifecyclePolicyPreviewRequest request where maxResults was used and the
 results exceeded the value of that parameter. Pagination continues from the end of the
 previous results that returned the nextToken value. This value is
 null when there are no more results to return. This option cannot be used when you specify images with imageIds.

iv_maxresults TYPE /AWS1/ECRLCPREVIEWMAXRESULTS /AWS1/ECRLCPREVIEWMAXRESULTS

The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in
 paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest only returns
 maxResults results in a single page along with a nextToken
 response element. The remaining results of the initial request can be seen by sending
 another GetLifecyclePolicyPreviewRequest request with the returned nextToken
 value. This value can be between 1 and 100. If this
 parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to
100 results and a nextToken value, if
 applicable. This option cannot be used when you specify images with imageIds.

io_filter TYPE REF TO /AWS1/CL_ECRLCPLYPREVIEWFILTER /AWS1/CL_ECRLCPLYPREVIEWFILTER

An optional parameter that filters results based on image tag status and all tags, if tagged.

RETURNING

oo_output TYPE REF TO /aws1/cl_ecrgetlcplypreviewrsp /AWS1/CL_ECRGETLCPLYPREVIEWRSP

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->getlifecyclepolicypreview(
  io_filter = new /aws1/cl_ecrlcplypreviewfilter( |string| )
  it_imageids = VALUE /aws1/cl_ecrimageidentifier=>tt_imageidentifierlist(
    (
      new /aws1/cl_ecrimageidentifier(
        iv_imagedigest = |string|
        iv_imagetag = |string|
      )
    )
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_registryid = |string|
  iv_repositoryname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_registryid = lo_result->get_registryid( ).
  lv_repositoryname = lo_result->get_repositoryname( ).
  lv_lifecyclepolicytext = lo_result->get_lifecyclepolicytext( ).
  lv_lifecyclepolicypreviews = lo_result->get_status( ).
  lv_nexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_previewresults( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      LOOP AT lo_row_1->get_imagetags( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_imagetag = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_imagedigest = lo_row_1->get_imagedigest( ).
      lv_pushtimestamp = lo_row_1->get_imagepushedat( ).
      lo_lifecyclepolicyruleacti = lo_row_1->get_action( ).
      IF lo_lifecyclepolicyruleacti IS NOT INITIAL.
        lv_imageactiontype = lo_lifecyclepolicyruleacti->get_type( ).
        lv_lifecyclepolicytargetst = lo_lifecyclepolicyruleacti->get_targetstorageclass( ).
      ENDIF.
      lv_lifecyclepolicyruleprio = lo_row_1->get_appliedrulepriority( ).
      lv_lifecyclepolicystoragec = lo_row_1->get_storageclass( ).
    ENDIF.
  ENDLOOP.
  lo_lifecyclepolicypreviews_1 = lo_result->get_summary( ).
  IF lo_lifecyclepolicypreviews_1 IS NOT INITIAL.
    lv_imagecount = lo_lifecyclepolicypreviews_1->get_expiringimagetotalcount( ).
    LOOP AT lo_lifecyclepolicypreviews_1->get_transingimagetotalcounts( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_lifecyclepolicytargetst = lo_row_5->get_targetstorageclass( ).
        lv_imagecount = lo_row_5->get_imagetotalcount( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.