Skip to content

/AWS1/CL_ECS=>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

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