LISTATTRIBUTES()`¶

About ListAttributes¶

Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value. You can do this, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).

Method Signature¶

METHODS /AWS1/IF_ECS~LISTATTRIBUTES
  IMPORTING
    !IV_CLUSTER TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_TARGETTYPE TYPE /AWS1/ECSTARGETTYPE OPTIONAL
    !IV_ATTRIBUTENAME TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_ATTRIBUTEVALUE TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/ECSBOXEDINTEGER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ecslistattrsresponse
  RAISING
    /AWS1/CX_ECSCLUSTERNOTFOUNDEX
    /AWS1/CX_ECSINVALIDPARAMETEREX
    /AWS1/CX_ECSCLIENTEXC
    /AWS1/CX_ECSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_targettype` `TYPE /AWS1/ECSTARGETTYPE` `/AWS1/ECSTARGETTYPE`¶

The type of the target to list attributes with.

Optional arguments:¶

`iv_cluster` `TYPE /AWS1/ECSSTRING` `/AWS1/ECSSTRING`¶

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

`iv_attributename` `TYPE /AWS1/ECSSTRING` `/AWS1/ECSSTRING`¶

The name of the attribute to filter the results with.

`iv_attributevalue` `TYPE /AWS1/ECSSTRING` `/AWS1/ECSSTRING`¶

The value of the attribute to filter results with. You must also specify an attribute name to use this parameter.

`iv_nexttoken` `TYPE /AWS1/ECSSTRING` `/AWS1/ECSSTRING`¶

The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

`iv_maxresults` `TYPE /AWS1/ECSBOXEDINTEGER` `/AWS1/ECSBOXEDINTEGER`¶

The maximum number of cluster results that ListAttributes returned in paginated output. When this parameter is used, ListAttributes 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 ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ecslistattrsresponse` `/AWS1/CL_ECSLISTATTRSRESPONSE`¶

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->listattributes(
  iv_attributename = |string|
  iv_attributevalue = |string|
  iv_cluster = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_targettype = |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_attributes( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_name( ).
      lv_string = lo_row_1->get_value( ).
      lv_targettype = lo_row_1->get_targettype( ).
      lv_string = lo_row_1->get_targetid( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

To list container instances that have a specific attribute¶

This example lists attributes for a container instance with the attribute "stack" equal to the value "production".

DATA(lo_result) = lo_client->listattributes(
  iv_attributename = |stack|
  iv_attributevalue = |production|
  iv_cluster = |MyCluster|
  iv_targettype = |container-instance|
).

/AWS1/IF_ECS=>LISTATTRIBUTES()¶