Describe Ecs Clusters

opsworks_describe_ecs_clusters

R Documentation

Describes Amazon ECS clusters that are registered with a stack

Description

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.

Usage

opsworks_describe_ecs_clusters(EcsClusterArns, StackId, NextToken,
  MaxResults)

Arguments

EcsClusterArns

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

StackId

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

NextToken

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 describe_ecs_clusters 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.

MaxResults

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.

Value

A list with the following syntax:

list(
  EcsClusters = list(
    list(
      EcsClusterArn = "string",
      EcsClusterName = "string",
      StackId = "string",
      RegisteredAt = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_ecs_clusters(
  EcsClusterArns = list(
    "string"
  ),
  StackId = "string",
  NextToken = "string",
  MaxResults = 123
)