DESCRIBEECSCLUSTERS()`¶

About DescribeEcsClusters¶

Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information about user permissions, see Managing User Permissions.

This call accepts only one resource-identifying parameter.

Method Signature¶

IMPORTING¶

Optional arguments:¶

`it_ecsclusterarns` `TYPE /AWS1/CL_OWXSTRINGS_W=>TT_STRINGS` `TT_STRINGS`¶

A list of ARNs, one for each cluster to be described.

`iv_stackid` `TYPE /AWS1/OWXSTRING` `/AWS1/OWXSTRING`¶

A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

`iv_nexttoken` `TYPE /AWS1/OWXSTRING` `/AWS1/OWXSTRING`¶

If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

`iv_maxresults` `TYPE /AWS1/OWXINTEGER` `/AWS1/OWXINTEGER`¶

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_owxdescrecsclustsrslt` `/AWS1/CL_OWXDESCRECSCLUSTSRSLT`¶

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->/aws1/if_owx~describeecsclusters(
  it_ecsclusterarns = VALUE /aws1/cl_owxstrings_w=>tt_strings(
    ( new /aws1/cl_owxstrings_w( |string| ) )
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_stackid = |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_ecsclusters( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_ecsclusterarn( ).
      lv_string = lo_row_1->get_ecsclustername( ).
      lv_string = lo_row_1->get_stackid( ).
      lv_datetime = lo_row_1->get_registeredat( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_OWX=>DESCRIBEECSCLUSTERS()¶