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

doc/issue describe_availability_zones: incorrect Wavelength Zone example for group-name #3994

Closed
mtulio opened this issue Jan 19, 2024 · 2 comments
Assignees
Labels
bug This issue is a confirmed bug. documentation This is a problem with documentation. ec2 p3 This is a minor priority issue

Comments

@mtulio
Copy link

mtulio commented Jan 19, 2024

Describe the issue

Hi,

The example for Wavelength Zones is incorrect in the Filter Name=group-name of the legend on the document linked to the issue for describe_availability_zones.

The zone group mentioned in the example (us-east-1-wl1-bos-wlz-1) is a zone name. The correct value must be us-east-1-wl1, see what AWS API returns:

        {
            "State": "available",
            "OptInStatus": "opted-in",
            "Messages": [],
            "RegionName": "us-east-1",
            "ZoneName": "us-east-1-wl1-bos-wlz-1",
            "ZoneId": "use1-wl1-bos-wlz1",
            "GroupName": "us-east-1-wl1",
            "NetworkBorderGroup": "us-east-1-wl1-bos-wlz-1",
            "ZoneType": "wavelength-zone",
            "ParentZoneName": "us-east-1a",
            "ParentZoneId": "use1-az4"
        },

The official AWS documentation is also incorrect, I submitted a feedback there:

https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/client/describe_availability_zones.html

@mtulio mtulio added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Jan 19, 2024
@RyanFitzSimmonsAK RyanFitzSimmonsAK self-assigned this May 3, 2024
@RyanFitzSimmonsAK RyanFitzSimmonsAK added bug This issue is a confirmed bug. investigating This issue is being investigated and/or work is in progress to resolve the issue. ec2 p3 This is a minor priority issue and removed needs-triage This issue or PR still needs to be triaged. labels May 3, 2024
@RyanFitzSimmonsAK
Copy link
Contributor

Hi @mtulio, thanks for reaching out, and for your patience. It looks like the feedback you submitted to the API reference was already implemented. It currently reads :

For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1).

The Boto3 documentation also has the fix, starting in version 1.34.61. Thanks again for submitting feedback!

@RyanFitzSimmonsAK RyanFitzSimmonsAK removed the investigating This issue is being investigated and/or work is in progress to resolve the issue. label May 3, 2024
Copy link

github-actions bot commented May 3, 2024

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a confirmed bug. documentation This is a problem with documentation. ec2 p3 This is a minor priority issue
Projects
None yet
Development

No branches or pull requests

2 participants