I see the required mark in the AWS APIs is misleading.

[shivam-sek21]

Describe the issue

I see the required mark in the AWS APIs is misleading/not correct, when someone refer them only to invoke the API.

Example:
For the API: AuthorizeSecurityGroupEgressCommand in the doc only parameter: 'GroupId' is given as required so passing only 'GroupId' gives 'MissingParameter' Issue and ask for the parameter: 'IpPermissions'.
I also looked in AWS SDK typescript 'AuthorizeSecurityGroupEgressRequest' interface, there also only 'GroupId' was required rest all where tagged optional.

Links

Reference:
API DOC: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ec2/command/AuthorizeSecurityGroupEgressCommand/

AuthorizeSecurityGroupEgressRequess interface:

aws-sdk-js-v3/clients/client-ec2/src/models/models_0.ts

Line 6796 in 7497406

export interface AuthorizeSecurityGroupEgressRequest {

[zshzbh]

Hey @shivam-sek21

Thanks for the feedback! I can see the issue.

This is the code I have -

import { EC2Client, AuthorizeSecurityGroupEgressCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, AuthorizeSecurityGroupEgressCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client({region: "us-east-1"});
// This example adds a rule that grants access to the specified security group on TCP port 80.
const input = {
	"GroupId": "sg-XXX",
	// "IpPermissions": [
	//   {
	// 	"FromPort": 80,
	// 	"IpProtocol": "tcp",
	// 	"ToPort": 80,
	// 	"UserIdGroupPairs": [
	// 	  {
	// 		"GroupId": "sg-XXXX"
	// 	  }
	// 	]
	//   }
	// ]
  };
  const command = new AuthorizeSecurityGroupEgressCommand(input);
  await client.send(command);
  // example id: to-add-a-rule-that-allows-outbound-traffic-to-a-specific-security-group-1528929760260
  

When I comment out the IpPermissions configs, I got error-

MissingParameter: The request must contain the parameter ipPermissions

I will bring it up to the team and update this issue accordingly.

[shivam-sek21]

Hi @zshzbh, I have seen these case for more than 7K APIs, please let me know if there exist any openapi specs for the AWS ?. I searched it all over the internet, but didn't find, please let me know if you guys can provide it.

[zshzbh]

Hey @shivam-sek21 ,

Could you please provide more details to help us understand-

I have seen these case for more than 7K APIs

[trivikr]

let me know if there exist any openapi specs for the AWS?

We use https://smithy.io/2.0/index.html, and the specs for AuthorizeSecurityGroupEgress API call are on line 8578
https://raw.githubusercontent.com/aws/aws-sdk-js-v3/a370f241842b10a3cff90de23a697026638af7bb/codegen/sdk-codegen/aws-models/ec2.json

[shivam-sek21]

Thanks for the response and providing the specs @trivikr , But I see there are many parameters in the APIs of AWS which supposed to be marked as oneOfs, anyOfs but they are not, they are marked as optional. Marking them as Oneofs and anyOfs might help a lot to developers.

[zshzbh]

I have submitted a ticket to service team to update their API specs. Please follow the release note and AWS posts for updates.

Thanks!