Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

describe_launch_configurations documentation with nonexistent parameter #3717

Closed
fariaass opened this issue May 22, 2023 · 4 comments
Closed
Assignees
Labels
autoscaling Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on use documentation This is a problem with documentation. p3 This is a minor priority issue

Comments

@fariaass
Copy link

Describe the issue

The describe_launch_configurations api call documentation has a nonexistent parameter in Response Syntax. The parameter is "ClassicLinkVPCId", that is not present at both AWS API and AWS CLI docs. I am leaving reference links bellow.

Links

AWS Boto3 docs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/autoscaling/client/describe_launch_configurations.html
AWS API docs: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeLaunchConfigurations.html
AWS CLI docs: https://docs.aws.amazon.com/cli/latest/reference/autoscaling/describe-launch-configurations.html

@fariaass fariaass added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels May 22, 2023
@RyanFitzSimmonsAK RyanFitzSimmonsAK self-assigned this May 22, 2023
@RyanFitzSimmonsAK RyanFitzSimmonsAK added autoscaling Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on use p3 This is a minor priority issue and removed needs-triage This issue or PR still needs to be triaged. labels May 22, 2023
@RyanFitzSimmonsAK
Copy link
Contributor

Hi @fariaass, thanks for reaching out. When you say "nonexistent parameter", do you mean that the field doesn't appear in an actual response? If so, could you provide debug logs demonstrating this behavior? Thanks!

@RyanFitzSimmonsAK RyanFitzSimmonsAK added the response-requested Waiting on additional information or feedback. label May 22, 2023
@fariaass
Copy link
Author

Hi @RyanFitzSimmonsAK! Yes, I was doing an automation with Lambda and some other services. When I called the describe_launch_configurations method and tried to access the "ClassicLinkVPCId" key, an error was returned to me. It was an IndexError, pointing that this key does not exist. So I went to the boto3 docs and compared with both AWS CLI and AWS API docs, where the key is not present. I will screenshots prints of code and logs.
Code:
image
CloudWatch Lambda Logs:
image
Thanks for the help!

@github-actions github-actions bot removed the response-requested Waiting on additional information or feedback. label May 23, 2023
@RyanFitzSimmonsAK
Copy link
Contributor

RyanFitzSimmonsAK commented Jun 5, 2023

Hi @fariaass, thanks for following up. I do want to quickly mention that the CLI and API docs do actually mention that ClassicLinkVPCId is returned, just like the Boto3 docs.

https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_LaunchConfiguration.html - API docs
CLI mentions it in the output section.

Anyway, the docs mention that this field exists for backward compatibility purposes, which is referring to EC2 Classic. EC2 Classic is deprecated, but older scripts might still need that functionality. If that field was set prior to the deprecation of EC2 Classic, it will be returned in the response. Otherwise, an empty field will not be returned. Fortunately, there isn't really a need to set the field ever since the deprecation. I hope that clears some things up, please let me know if you have any follow-up questions.

@RyanFitzSimmonsAK RyanFitzSimmonsAK added the response-requested Waiting on additional information or feedback. label Jun 5, 2023
@fariaass
Copy link
Author

fariaass commented Jun 6, 2023

Hi @RyanFitzSimmonsAK! Thanks for the explanation, I got it now. Sorry for spending your time with a mistake by my side!

@github-actions github-actions bot removed the response-requested Waiting on additional information or feedback. label Jun 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autoscaling Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on use documentation This is a problem with documentation. p3 This is a minor priority issue
Projects
None yet
Development

No branches or pull requests

2 participants