DESCRIBEIMAGES()`¶

About DescribeImages¶

Returns metadata that's related to the images in a repository in a public registry.

Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size. Therefore, it might return a larger image size than the image sizes that are returned by DescribeImages.

Method Signature¶

METHODS /AWS1/IF_ECP~DESCRIBEIMAGES
  IMPORTING
    !IV_REGISTRYID TYPE /AWS1/ECPREGISTRYID OPTIONAL
    !IV_REPOSITORYNAME TYPE /AWS1/ECPREPOSITORYNAME OPTIONAL
    !IT_IMAGEIDS TYPE /AWS1/CL_ECPIMAGEIDENTIFIER=>TT_IMAGEIDENTIFIERLIST OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ECPNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/ECPMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ecpdescrimagesrsp
  RAISING
    /AWS1/CX_ECPIMAGENOTFOUNDEX
    /AWS1/CX_ECPINVALIDPARAMETEREX
    /AWS1/CX_ECPREPOSITORYNOTFNDEX
    /AWS1/CX_ECPSERVEREXCEPTION
    /AWS1/CX_ECPUNSUPPEDCOMMANDEX
    /AWS1/CX_ECPCLIENTEXC
    /AWS1/CX_ECPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_repositoryname` `TYPE /AWS1/ECPREPOSITORYNAME` `/AWS1/ECPREPOSITORYNAME`¶

The repository that contains the images to describe.

Optional arguments:¶

`iv_registryid` `TYPE /AWS1/ECPREGISTRYID` `/AWS1/ECPREGISTRYID`¶

The Amazon Web Services account ID that's associated with the public registry that contains the repository where images are described. If you do not specify a registry, the default public registry is assumed.

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

The list of image IDs for the requested repository.

`iv_nexttoken` `TYPE /AWS1/ECPNEXTTOKEN` `/AWS1/ECPNEXTTOKEN`¶

The nextToken value that's returned from a previous paginated DescribeImages 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. If there are no more results to return, this value is null. If you specify images with imageIds, you can't use this option.

`iv_maxresults` `TYPE /AWS1/ECPMAXRESULTS` `/AWS1/ECPMAXRESULTS`¶

The maximum number of repository results that's returned by DescribeImages in paginated output. When this parameter is used, DescribeImages only returns maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter isn't used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. If you specify images with imageIds, you can't use this option.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ecpdescrimagesrsp` `/AWS1/CL_ECPDESCRIMAGESRSP`¶

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->describeimages(
  it_imageids = VALUE /aws1/cl_ecpimageidentifier=>tt_imageidentifierlist(
    (
      new /aws1/cl_ecpimageidentifier(
        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.
  LOOP AT lo_result->get_imagedetails( ) 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( ).
      lv_imagedigest = lo_row_1->get_imagedigest( ).
      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_imagesizeinbytes = lo_row_1->get_imagesizeinbytes( ).
      lv_pushtimestamp = lo_row_1->get_imagepushedat( ).
      lv_mediatype = lo_row_1->get_imagemanifestmediatype( ).
      lv_mediatype = lo_row_1->get_artifactmediatype( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_ECP=>DESCRIBEIMAGES()¶