OpsWorks / Paginator / DescribeEcsClusters


class OpsWorks.Paginator.DescribeEcsClusters#
paginator = client.get_paginator('describe_ecs_clusters')

Creates an iterator that will paginate through responses from OpsWorks.Client.describe_ecs_clusters().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • EcsClusterArns (list) –

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

    • (string) –

  • StackId (string) – A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'EcsClusters': [
            'EcsClusterArn': 'string',
            'EcsClusterName': 'string',
            'StackId': 'string',
            'RegisteredAt': 'string'


Response Structure

  • (dict) –

    Contains the response to a DescribeEcsClusters request.

    • EcsClusters (list) –

      A list of EcsCluster objects containing the cluster descriptions.

      • (dict) –

        Describes a registered Amazon ECS cluster.

        • EcsClusterArn (string) –

          The cluster’s ARN.

        • EcsClusterName (string) –

          The cluster name.

        • StackId (string) –

          The stack ID.

        • RegisteredAt (string) –

          The time and date that the cluster was registered with the stack.