/AWS1/CL_OWX=>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's
NextToken
parameter value is set to a token. To retrieve the next set of results, callDescribeEcsClusters
again and assign that token to the request object'sNextToken
parameter. If there are no remaining results, the previous response object'sNextToken
parameter is set tonull
.
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 theNextToken
request parameter to get the next set of results.