BATCHGETIMAGE()`¶

About BatchGetImage¶

Gets detailed information for an image. Images are specified with either an imageTag or imageDigest.

When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.

Method Signature¶

METHODS /AWS1/IF_ECR~BATCHGETIMAGE
  IMPORTING
    !IV_REGISTRYID TYPE /AWS1/ECRREGISTRYID OPTIONAL
    !IV_REPOSITORYNAME TYPE /AWS1/ECRREPOSITORYNAME OPTIONAL
    !IT_IMAGEIDS TYPE /AWS1/CL_ECRIMAGEIDENTIFIER=>TT_IMAGEIDENTIFIERLIST OPTIONAL
    !IT_ACCEPTEDMEDIATYPES TYPE /AWS1/CL_ECRMEDIATYPELIST_W=>TT_MEDIATYPELIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ecrbatchgetimagersp
  RAISING
    /AWS1/CX_ECRINVALIDPARAMETEREX
    /AWS1/CX_ECRLIMITEXCEEDEDEX
    /AWS1/CX_ECRREPOSITORYNOTFNDEX
    /AWS1/CX_ECRSERVEREXCEPTION
    /AWS1/CX_ECRUNABLETOGETUPSTR01
    /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 repository that contains the images to describe.

`it_imageids` `TYPE /AWS1/CL_ECRIMAGEIDENTIFIER=>TT_IMAGEIDENTIFIERLIST` `TT_IMAGEIDENTIFIERLIST`¶

A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

Optional arguments:¶

`iv_registryid` `TYPE /AWS1/ECRREGISTRYID` `/AWS1/ECRREGISTRYID`¶

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

`it_acceptedmediatypes` `TYPE /AWS1/CL_ECRMEDIATYPELIST_W=>TT_MEDIATYPELIST` `TT_MEDIATYPELIST`¶

The accepted media types for the request.

Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ecrbatchgetimagersp` `/AWS1/CL_ECRBATCHGETIMAGERSP`¶

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->batchgetimage(
  it_acceptedmediatypes = VALUE /aws1/cl_ecrmediatypelist_w=>tt_mediatypelist(
    ( new /aws1/cl_ecrmediatypelist_w( |string| ) )
  )
  it_imageids = VALUE /aws1/cl_ecrimageidentifier=>tt_imageidentifierlist(
    (
      new /aws1/cl_ecrimageidentifier(
        iv_imagedigest = |string|
        iv_imagetag = |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.
  LOOP AT lo_result->get_images( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_registryid = lo_row_1->get_registryid( ).
      lv_repositoryname = lo_row_1->get_repositoryname( ).
      lo_imageidentifier = lo_row_1->get_imageid( ).
      IF lo_imageidentifier IS NOT INITIAL.
        lv_imagedigest = lo_imageidentifier->get_imagedigest( ).
        lv_imagetag = lo_imageidentifier->get_imagetag( ).
      ENDIF.
      lv_imagemanifest = lo_row_1->get_imagemanifest( ).
      lv_mediatype = lo_row_1->get_imagemanifestmediatype( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_failures( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lo_imageidentifier = lo_row_3->get_imageid( ).
      IF lo_imageidentifier IS NOT INITIAL.
        lv_imagedigest = lo_imageidentifier->get_imagedigest( ).
        lv_imagetag = lo_imageidentifier->get_imagetag( ).
      ENDIF.
      lv_imagefailurecode = lo_row_3->get_failurecode( ).
      lv_imagefailurereason = lo_row_3->get_failurereason( ).
    ENDIF.
  ENDLOOP.
ENDIF.

To obtain multiple images in a single request¶

This example obtains information for an image with a specified image digest ID from the repository named ubuntu in the current account.

DATA(lo_result) = lo_client->batchgetimage(
  it_imageids = VALUE /aws1/cl_ecrimageidentifier=>tt_imageidentifierlist(
    ( new /aws1/cl_ecrimageidentifier( iv_imagetag = |precise| )  )
  )
  iv_repositoryname = |ubuntu|
).

/AWS1/IF_ECR=>BATCHGETIMAGE()¶