EKS - describe_cluster has incorrect parameter name

[durgajay]

Describe the issue

The parameter ClusterId is incorrect for the function describe_cluster, the code fails with the message Parameter validation failed: Missing required parameter in input: "name" Unknown parameter in input: "ClusterId", must be one of: name

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/emr/client/describe_cluster.html

[RyanFitzSimmonsAK]

Hi @durgajay, thanks for reaching out. I had some trouble reproducing the error you got. Could you tell me what version of Boto3 you're on, as well as provide a code snippet showing how you're calling it? Thanks!

[durgajay]

Hello,

Here is the sample code that fails

    eks_client       = boto3.client("eks")
    vpc_info_resp    = eks_client.describe_cluster(ClusterId="test-cluster")
    vpc_id           = vpc_info_resp['cluster']['resourcesVpcConfig']['vpcId']
    print(vpc_id)

changing line # 2 to below works.

    vpc_info_resp    = eks_client.describe_cluster(name="test-cluster")

Below is the snippet from the documentation and as you notice ClusterId is not a valid parameter.
describe_cluster
EMR.Client.describe_cluster(**kwargs)

Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.

See also: AWS API Documentation
Request Syntax

response = client.describe_cluster(
    ClusterId='string'
)

Parameters:
ClusterId (string) –
[REQUIRED]
The identifier of the cluster to describe.

[RyanFitzSimmonsAK]

Hi @durgajay, thanks for following up. The documentation you linked is for EMR, while the command you are trying to use is for EKS. The EKS describe-cluster operation does use name as a parameter (https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-cluster.html). Hope that helps, please let me know if you have any follow-up questions.

[durgajay]

Apologies, it was my bad... had multiple windows open :)