EKS / Client / list_capabilities

list_capabilities

EKS.Client.list_capabilities(**kwargs)

Lists all managed capabilities in your Amazon EKS cluster. You can use this operation to get an overview of all capabilities and their current status.

See also: AWS API Documentation

Request Syntax

response = client.list_capabilities(
    clusterName='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • clusterName (string) –

    [REQUIRED]

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

  • nextToken (string) – The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

  • maxResults (integer) – The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you don’t specify a value, the default is 100 results.

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) –

      The nextToken value to include in a future ListCapabilities request. When the results of a ListCapabilities request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions