Skip to content

Document single value limitations for launch_instances function #4702

@beardedsamwise

Description

@beardedsamwise

Describe the issue

The documentation for the launch_instances function should make it clear that even though the following three parameters are plural, they only accept a list with a single value. The parameters are by their nature misleading (though apparently named that way for potential future expansion according to AWS Support) so documentation would help end users understand correct usage.

  • AvailabilityZones
  • AvailabilityZoneIds
  • SubnetIds

I should note that the actual API does note this limitation, as does the general documentation.

If we look at the enter_standby function we can see a similar limitation is well documented for the InstanceIds parameter where a maximum of 20 instances can be specified, so there is a precedent for the launch_instance function to be of a similar standard.

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/autoscaling/client/launch_instances.html

Metadata

Metadata

Labels

autoscalingAmazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on usedocumentationThis is a problem with documentation.feature-requestThis issue requests a feature.p3This is a minor priority issueresponse-requestedWaiting on additional information or feedback.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions