EKS / Paginator / ListCapabilities

ListCapabilities

class EKS.Paginator.ListCapabilities

paginator = client.get_paginator('list_capabilities')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EKS.Client.list_capabilities().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    clusterName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• clusterName (string) –

  [REQUIRED]

  The name of the Amazon EKS cluster for which you want to list capabilities.

• 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:

dict

Returns:

Response Syntax

{
    'capabilities': [
        {
            'capabilityName': 'string',
            'arn': 'string',
            'type': 'ACK'|'KRO'|'ARGOCD',
            'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'DELETING'|'DELETE_FAILED'|'ACTIVE'|'DEGRADED',
            'version': 'string',
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • capabilities (list) –

    A list of capability summary objects, each containing basic information about a capability including its name, ARN, type, status, version, and timestamps.

    • (dict) –

      A summary of a capability, containing basic information without the full configuration details. This is returned by the ListCapabilities operation.

      • capabilityName (string) –

        The unique name of the capability within the cluster.

      • arn (string) –

        The Amazon Resource Name (ARN) of the capability.

      • type (string) –

        The type of capability. Valid values are ACK, ARGOCD, or KRO.

      • status (string) –

        The current status of the capability.

      • version (string) –

        The version of the capability software that is currently running.

      • createdAt (datetime) –

        The Unix epoch timestamp in seconds for when the capability was created.

      • modifiedAt (datetime) –

        The Unix epoch timestamp in seconds for when the capability was last modified.

  • NextToken (string) –

    A token to resume pagination.