Skip to content

Commit

Permalink
docs: fix example generation for empty inputs (#5710)
Browse files Browse the repository at this point in the history
  • Loading branch information
kuhe authored Jan 23, 2024
1 parent 5a19a33 commit e6a4a1e
Show file tree
Hide file tree
Showing 49 changed files with 46 additions and 65 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export interface DescribeAccountLimitsCommandOutput extends DescribeAccountLimit
* @example To describe your Auto Scaling account limits
* ```javascript
* // This example describes the Amazon EC2 Auto Scaling service quotas for your account.
* const input = undefined;
* const input = {};
* const command = new DescribeAccountLimitsCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ export interface DescribeAdjustmentTypesCommandOutput extends DescribeAdjustment
* @example To describe the Amazon EC2 Auto Scaling adjustment types
* ```javascript
* // This example describes the available adjustment types.
* const input = undefined;
* const input = {};
* const command = new DescribeAdjustmentTypesCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export interface DescribeAutoScalingNotificationTypesCommandOutput
* @example To describe the Auto Scaling notification types
* ```javascript
* // This example describes the available notification types.
* const input = undefined;
* const input = {};
* const command = new DescribeAutoScalingNotificationTypesCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ export interface DescribeLifecycleHookTypesCommandOutput extends DescribeLifecyc
* @example To describe the available types of lifecycle hooks
* ```javascript
* // This example describes the available lifecycle hook types.
* const input = undefined;
* const input = {};
* const command = new DescribeLifecycleHookTypesCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ export interface DescribeMetricCollectionTypesCommandOutput
* @example To describe the Auto Scaling metric collection types
* ```javascript
* // This example describes the available metric collection types.
* const input = undefined;
* const input = {};
* const command = new DescribeMetricCollectionTypesCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export interface DescribeScalingProcessTypesCommandOutput extends ProcessesType,
* @example To describe the Auto Scaling process types
* ```javascript
* // This example describes the Auto Scaling process types.
* const input = undefined;
* const input = {};
* const command = new DescribeScalingProcessTypesCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ export interface DescribeTerminationPolicyTypesCommandOutput
* @example To describe termination policy types
* ```javascript
* // This example describes the available termination policy types.
* const input = undefined;
* const input = {};
* const command = new DescribeTerminationPolicyTypesCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
2 changes: 1 addition & 1 deletion clients/client-ec2/src/commands/AllocateAddressCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ export interface AllocateAddressCommandOutput extends AllocateAddressResult, __M
* @example To allocate an Elastic IP address
* ```javascript
* // This example allocates an Elastic IP address.
* const input = undefined;
* const input = {};
* const command = new AllocateAddressCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ export interface CreateInternetGatewayCommandOutput extends CreateInternetGatewa
* @example To create an Internet gateway
* ```javascript
* // This example creates an Internet gateway.
* const input = undefined;
* const input = {};
* const command = new CreateInternetGatewayCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ export interface DeleteSpotDatafeedSubscriptionCommandOutput extends __MetadataB
* @example To cancel a Spot Instance data feed subscription
* ```javascript
* // This example deletes a Spot data feed subscription for the account.
* const input = undefined;
* const input = {};
* const command = new DeleteSpotDatafeedSubscriptionCommand(input);
* await client.send(command);
* // example id: ec2-delete-spot-datafeed-subscription-1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ export interface DescribeAccountAttributesCommandOutput extends DescribeAccountA
* @example To describe all attributes for your AWS account
* ```javascript
* // This example describes the attributes for your AWS account.
* const input = undefined;
* const input = {};
* const command = new DescribeAccountAttributesCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ export interface DescribeAddressesCommandOutput extends DescribeAddressesResult,
* @example To describe your Elastic IP addresses
* ```javascript
* // This example describes your Elastic IP addresses.
* const input = undefined;
* const input = {};
* const command = new DescribeAddressesCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ export interface DescribeAvailabilityZonesCommandOutput extends DescribeAvailabi
* @example To describe your Availability Zones
* ```javascript
* // This example describes the Availability Zones that are available to you. The response includes Availability Zones only for the current region.
* const input = undefined;
* const input = {};
* const command = new DescribeAvailabilityZonesCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ export interface DescribeMovingAddressesCommandOutput extends DescribeMovingAddr
* @example To describe your moving addresses
* ```javascript
* // This example describes all of your moving Elastic IP addresses.
* const input = undefined;
* const input = {};
* const command = new DescribeMovingAddressesCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
2 changes: 1 addition & 1 deletion clients/client-ec2/src/commands/DescribeRegionsCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export interface DescribeRegionsCommandOutput extends DescribeRegionsResult, __M
* @example To describe your regions
* ```javascript
* // This example describes all the regions that are available to you.
* const input = undefined;
* const input = {};
* const command = new DescribeRegionsCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ export interface DescribeSpotDatafeedSubscriptionCommandOutput
* @example To describe the datafeed for your AWS account
* ```javascript
* // This example describes the Spot Instance datafeed subscription for your AWS account.
* const input = undefined;
* const input = {};
* const command = new DescribeSpotDatafeedSubscriptionCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
1 change: 0 additions & 1 deletion clients/client-ec2/src/models/models_2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ import {
VpcAttachment,
VpcPeeringConnection,
} from "./models_0";

import {
CarrierGateway,
ClientVpnEndpointStatus,
Expand Down
2 changes: 0 additions & 2 deletions clients/client-ec2/src/models/models_3.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ import {
VerifiedAccessTrustProvider,
VerifiedAccessTrustProviderFilterSensitiveLog,
} from "./models_0";

import {
AttributeValue,
BlockDeviceMapping,
Expand Down Expand Up @@ -71,7 +70,6 @@ import {
TrafficType,
TransportProtocol,
} from "./models_1";

import {
FleetStateCode,
SubnetCidrReservation,
Expand Down
3 changes: 0 additions & 3 deletions clients/client-ec2/src/models/models_4.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ import {
TagSpecification,
UserIdGroupPair,
} from "./models_0";

import {
AmdSevSnpSpecification,
AttributeValue,
Expand Down Expand Up @@ -69,7 +68,6 @@ import {
TargetCapacityUnitType,
Tenancy,
} from "./models_1";

import {
NetworkInterface,
NetworkInterfacePermission,
Expand All @@ -83,7 +81,6 @@ import {
SpotInstanceStateFault,
StorageTier,
} from "./models_2";

import {
ArchitectureValues,
BootModeValues,
Expand Down
4 changes: 0 additions & 4 deletions clients/client-ec2/src/models/models_5.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ import {
VpcIpv6CidrBlockAssociation,
VpcPeeringConnection,
} from "./models_0";

import { DiskImageFormat, InstanceRequirementsRequest, IpamResourceTag, Subnet, VolumeType, Vpc } from "./models_1";

import {
ConnectionNotification,
DnsEntry,
Expand Down Expand Up @@ -63,7 +61,6 @@ import {
VpnConnectionFilterSensitiveLog,
VpnGateway,
} from "./models_2";

import {
ExportTaskS3Location,
FastLaunchLaunchTemplateSpecificationResponse,
Expand All @@ -79,7 +76,6 @@ import {
StatisticType,
VirtualizationType,
} from "./models_3";

import { ArchitectureType, AttributeBooleanValue } from "./models_4";

/**
Expand Down
5 changes: 0 additions & 5 deletions clients/client-ec2/src/models/models_6.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ import {
VerifiedAccessTrustProvider,
VerifiedAccessTrustProviderFilterSensitiveLog,
} from "./models_0";

import {
AttributeValue,
BlockDeviceMapping,
Expand Down Expand Up @@ -74,7 +73,6 @@ import {
TargetCapacityUnitType,
VolumeType,
} from "./models_1";

import {
AutoAcceptSharedAttachmentsValue,
DefaultRouteTableAssociationValue,
Expand Down Expand Up @@ -109,7 +107,6 @@ import {
VpnEcmpSupportValue,
VpnTunnelLogOptionsSpecification,
} from "./models_2";

import {
ArchitectureValues,
BootModeValues,
Expand All @@ -130,7 +127,6 @@ import {
TpmSupportValues,
VirtualizationType,
} from "./models_3";

import {
AnalysisStatus,
ArchitectureType,
Expand All @@ -155,7 +151,6 @@ import {
SnapshotTaskDetail,
SnapshotTaskDetailFilterSensitiveLog,
} from "./models_4";

import {
InstanceFamilyCreditSpecification,
IpamComplianceStatus,
Expand Down
5 changes: 0 additions & 5 deletions clients/client-ec2/src/models/models_7.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import {
TransitGatewayVpcAttachment,
UnsuccessfulItem,
} from "./models_0";

import {
AmdSevSnpSpecification,
BlockDeviceMapping,
Expand All @@ -38,11 +37,8 @@ import {
ShutdownBehavior,
SpotInstanceType,
} from "./models_1";

import { SnapshotState, SSEType, TransitGatewayRoute } from "./models_2";

import { ClientVpnConnectionStatus, Filter } from "./models_3";

import {
HttpTokensState,
InstanceAttributeName,
Expand All @@ -62,7 +58,6 @@ import {
SpotInstanceRequestFilterSensitiveLog,
SpotPlacement,
} from "./models_4";

import {
CapacityReservationSpecification,
InstanceMonitoring,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ export interface CreateStorageLocationCommandOutput extends CreateStorageLocatio
* @example To create a new environment for an application
* ```javascript
* // The following operation creates a new environment for version v1 of a java application named my-app:
* const input = undefined;
* const input = {};
* const command = new CreateStorageLocationCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ export interface ListAvailableSolutionStacksCommandOutput
* @example To view solution stacks
* ```javascript
* // The following operation lists solution stacks for all currently available platform configurations and any that you have used in the past:
* const input = undefined;
* const input = {};
* const command = new ListAvailableSolutionStacksCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export interface DeleteAccountPasswordPolicyCommandOutput extends __MetadataBear
* @example To delete the current account password policy
* ```javascript
* // The following command removes the password policy from the current AWS account:
* const input = undefined;
* const input = {};
* const command = new DeleteAccountPasswordPolicyCommand(input);
* await client.send(command);
* // example id: 9ddf755e-495c-49bc-ae3b-ea6cc9b8ebcf
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ export interface GetAccountPasswordPolicyCommandOutput extends GetAccountPasswor
* @example To see the current account password policy
* ```javascript
* // The following command displays details about the password policy for the current AWS account.
* const input = undefined;
* const input = {};
* const command = new GetAccountPasswordPolicyCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export interface GetAccountSummaryCommandOutput extends GetAccountSummaryRespons
* @example To get information about IAM entity quotas and usage in the current account
* ```javascript
* // The following command returns information about the IAM entity quotas and usage in the current AWS account.
* const input = undefined;
* const input = {};
* const command = new GetAccountSummaryCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export interface DescribeCrossAccountAccessRoleCommandOutput
* @example Describte cross account access role
* ```javascript
* // Describes the IAM role that enables Amazon Inspector to access your AWS account.
* const input = undefined;
* const input = {};
* const command = new DescribeCrossAccountAccessRoleCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
2 changes: 1 addition & 1 deletion clients/client-kms/src/commands/ListAliasesCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ export interface ListAliasesCommandOutput extends ListAliasesResponse, __Metadat
* @example To list aliases
* ```javascript
* // The following example lists aliases.
* const input = undefined;
* const input = {};
* const command = new ListAliasesCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
2 changes: 1 addition & 1 deletion clients/client-kms/src/commands/ListKeysCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ export interface ListKeysCommandOutput extends ListKeysResponse, __MetadataBeare
* @example To list KMS keys
* ```javascript
* // The following example lists KMS keys.
* const input = undefined;
* const input = {};
* const command = new ListKeysCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ export interface DescribeOrganizationCommandOutput extends DescribeOrganizationR
* @example To get information about an organization
* ```javascript
* // The following example shows how to request information about the current user's organization:/n/n
* const input = undefined;
* const input = {};
* const command = new DescribeOrganizationCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,7 @@ export interface LeaveOrganizationCommandOutput extends __MetadataBearer {}
* @example To leave an organization as a member account
* ```javascript
* // TThe following example shows how to remove your member account from an organization:
* const input = undefined;
* const input = {};
* const command = new LeaveOrganizationCommand(input);
* await client.send(command);
* // example id: to-leave-an-organization-as-a-member-account-1472508784736
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ export interface ListHandshakesForAccountCommandOutput extends ListHandshakesFor
* @example To retrieve a list of the handshakes sent to an account
* ```javascript
* // The following example shows you how to get a list of handshakes that are associated with the account of the credentials used to call the operation:
* const input = undefined;
* const input = {};
* const command = new ListHandshakesForAccountCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ export interface ListHandshakesForOrganizationCommandOutput
* @example To retrieve a list of the handshakes associated with an organization
* ```javascript
* // The following example shows you how to get a list of handshakes associated with the current organization:
* const input = undefined;
* const input = {};
* const command = new ListHandshakesForOrganizationCommand(input);
* const response = await client.send(command);
* /* response ==
Expand Down
Loading

0 comments on commit e6a4a1e

Please sign in to comment.