AWS CLI Command Reference

[ aws . eks ]

describe-capability

Description

Returns detailed information about a specific managed capability in your Amazon EKS cluster, including its current status, configuration, health information, and any issues that may be affecting its operation.

See also: AWS API Documentation

Synopsis

  describe-capability
--cluster-name <value>
--capability-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--cluster-name (string) [required]

The name of the Amazon EKS cluster that contains the capability you want to describe.

--capability-name (string) [required]

The name of the capability to describe.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

capability -> (structure)

An object containing detailed information about the capability, including its name, ARN, type, status, version, configuration, health status, and timestamps for when it was created and last modified.

capabilityName -> (string)

The unique name of the capability within the cluster.

arn -> (string)

The Amazon Resource Name (ARN) of the capability.

clusterName -> (string)

The name of the Amazon EKS cluster that contains this capability.

type -> (string)

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

Possible values:

  • ACK
  • KRO
  • ARGOCD

roleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with Amazon Web Services services.

status -> (string)

The current status of the capability. Valid values include:

  • CREATING – The capability is being created.
  • ACTIVE – The capability is running and available.
  • UPDATING – The capability is being updated.
  • DELETING – The capability is being deleted.
  • CREATE_FAILED – The capability creation failed.
  • UPDATE_FAILED – The capability update failed.
  • DELETE_FAILED – The capability deletion failed.

Possible values:

  • CREATING
  • CREATE_FAILED
  • UPDATING
  • DELETING
  • DELETE_FAILED
  • ACTIVE
  • DEGRADED

version -> (string)

The version of the capability software that is currently running.

configuration -> (structure)

The configuration settings for the capability. The structure varies depending on the capability type.

argoCd -> (structure)

Configuration settings for an Argo CD capability, including the server URL and other Argo CD-specific settings.

namespace -> (string)

The Kubernetes namespace where Argo CD resources are monitored by your Argo CD Capability.

awsIdc -> (structure)

The IAM Identity CenterIAM; Identity Center integration configuration.

idcInstanceArn -> (string)

The Amazon Resource Name (ARN) of the IAM Identity CenterIAM; Identity Center instance used for authentication.

idcRegion -> (string)

The Region where the IAM Identity CenterIAM; Identity Center instance is located.

idcManagedApplicationArn -> (string)

The Amazon Resource Name (ARN) of the managed application created in IAM Identity CenterIAM; Identity Center for this Argo CD capability. This application is automatically created and managed by Amazon EKS.

rbacRoleMappings -> (list)

The list of role mappings that define which IAM Identity CenterIAM; Identity Center users or groups have which Argo CD roles.

(structure)

A mapping between an Argo CD role and IAM Identity CenterIAM; Identity Center identities. This defines which users or groups have specific permissions in Argo CD.

role -> (string) [required]

The Argo CD role to assign. Valid values are:

  • ADMIN – Full administrative access to Argo CD.
  • EDITOR – Edit access to Argo CD resources.
  • VIEWER – Read-only access to Argo CD resources.

Possible values:

  • ADMIN
  • EDITOR
  • VIEWER

identities -> (list) [required]

A list of IAM Identity CenterIAM; Identity Center identities (users or groups) that should be assigned this Argo CD role.

(structure)

An IAM Identity CenterIAM; Identity Center identity (user or group) that can be assigned permissions in a capability.

id -> (string) [required]

The unique identifier of the IAM Identity CenterIAM; Identity Center user or group.

type -> (string) [required]

The type of identity. Valid values are SSO_USER or SSO_GROUP .

Possible values:

  • SSO_USER
  • SSO_GROUP

networkAccess -> (structure)

The network access configuration for the Argo CD capability’s managed API server endpoint. If VPC endpoint IDs are specified, public access is blocked and the Argo CD server is only accessible through the specified VPC endpoints.

vpceIds -> (list)

The list of VPC endpoint IDs associated with the managed Argo CD API server endpoint. Each VPC endpoint provides private connectivity from a specific VPC to the Argo CD server.

(string)

serverUrl -> (string)

The URL of the Argo CD server. Use this URL to access the Argo CD web interface and API.

tags -> (map)

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource – 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length – 128 Unicode characters in UTF-8
  • Maximum value length – 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Constraints:

  • min: 1
  • max: 50

key -> (string)

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

Constraints:

  • min: 1
  • max: 128

value -> (string)

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Constraints:

  • max: 256

health -> (structure)

Health information for the capability, including any issues that may be affecting its operation.

issues -> (list)

A list of issues affecting the capability. If this list is empty, the capability is healthy.

(structure)

An issue affecting a capability’s health or operation.

code -> (string)

A code identifying the type of issue. This can be used to programmatically handle specific issue types.

Possible values:

  • AccessDenied
  • ClusterUnreachable

message -> (string)

A human-readable message describing the issue and potential remediation steps.

createdAt -> (timestamp)

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

modifiedAt -> (timestamp)

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

deletePropagationPolicy -> (string)

The delete propagation policy for the capability. Currently, the only supported value is RETAIN , which keeps all resources managed by the capability when the capability is deleted.

Possible values:

  • RETAIN
© Copyright 2025, Amazon Web Services. Created using Sphinx.