Skip to content

Commit e6a4a1e

Browse files
authored
docs: fix example generation for empty inputs (#5710)
1 parent 5a19a33 commit e6a4a1e

File tree

49 files changed

+46
-65
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+46
-65
lines changed

clients/client-auto-scaling/src/commands/DescribeAccountLimitsCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ export interface DescribeAccountLimitsCommandOutput extends DescribeAccountLimit
6767
* @example To describe your Auto Scaling account limits
6868
* ```javascript
6969
* // This example describes the Amazon EC2 Auto Scaling service quotas for your account.
70-
* const input = undefined;
70+
* const input = {};
7171
* const command = new DescribeAccountLimitsCommand(input);
7272
* const response = await client.send(command);
7373
* /* response ==

clients/client-auto-scaling/src/commands/DescribeAdjustmentTypesCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ export interface DescribeAdjustmentTypesCommandOutput extends DescribeAdjustment
8383
* @example To describe the Amazon EC2 Auto Scaling adjustment types
8484
* ```javascript
8585
* // This example describes the available adjustment types.
86-
* const input = undefined;
86+
* const input = {};
8787
* const command = new DescribeAdjustmentTypesCommand(input);
8888
* const response = await client.send(command);
8989
* /* response ==

clients/client-auto-scaling/src/commands/DescribeAutoScalingNotificationTypesCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ export interface DescribeAutoScalingNotificationTypesCommandOutput
6767
* @example To describe the Auto Scaling notification types
6868
* ```javascript
6969
* // This example describes the available notification types.
70-
* const input = undefined;
70+
* const input = {};
7171
* const command = new DescribeAutoScalingNotificationTypesCommand(input);
7272
* const response = await client.send(command);
7373
* /* response ==

clients/client-auto-scaling/src/commands/DescribeLifecycleHookTypesCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ export interface DescribeLifecycleHookTypesCommandOutput extends DescribeLifecyc
7575
* @example To describe the available types of lifecycle hooks
7676
* ```javascript
7777
* // This example describes the available lifecycle hook types.
78-
* const input = undefined;
78+
* const input = {};
7979
* const command = new DescribeLifecycleHookTypesCommand(input);
8080
* const response = await client.send(command);
8181
* /* response ==

clients/client-auto-scaling/src/commands/DescribeMetricCollectionTypesCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ export interface DescribeMetricCollectionTypesCommandOutput
7474
* @example To describe the Auto Scaling metric collection types
7575
* ```javascript
7676
* // This example describes the available metric collection types.
77-
* const input = undefined;
77+
* const input = {};
7878
* const command = new DescribeMetricCollectionTypesCommand(input);
7979
* const response = await client.send(command);
8080
* /* response ==

clients/client-auto-scaling/src/commands/DescribeScalingProcessTypesCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export interface DescribeScalingProcessTypesCommandOutput extends ProcessesType,
6565
* @example To describe the Auto Scaling process types
6666
* ```javascript
6767
* // This example describes the Auto Scaling process types.
68-
* const input = undefined;
68+
* const input = {};
6969
* const command = new DescribeScalingProcessTypesCommand(input);
7070
* const response = await client.send(command);
7171
* /* response ==

clients/client-auto-scaling/src/commands/DescribeTerminationPolicyTypesCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ export interface DescribeTerminationPolicyTypesCommandOutput
7070
* @example To describe termination policy types
7171
* ```javascript
7272
* // This example describes the available termination policy types.
73-
* const input = undefined;
73+
* const input = {};
7474
* const command = new DescribeTerminationPolicyTypesCommand(input);
7575
* const response = await client.send(command);
7676
* /* response ==

clients/client-ec2/src/commands/AllocateAddressCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ export interface AllocateAddressCommandOutput extends AllocateAddressResult, __M
9292
* @example To allocate an Elastic IP address
9393
* ```javascript
9494
* // This example allocates an Elastic IP address.
95-
* const input = undefined;
95+
* const input = {};
9696
* const command = new AllocateAddressCommand(input);
9797
* const response = await client.send(command);
9898
* /* response ==

clients/client-ec2/src/commands/CreateInternetGatewayCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ export interface CreateInternetGatewayCommandOutput extends CreateInternetGatewa
8787
* @example To create an Internet gateway
8888
* ```javascript
8989
* // This example creates an Internet gateway.
90-
* const input = undefined;
90+
* const input = {};
9191
* const command = new CreateInternetGatewayCommand(input);
9292
* const response = await client.send(command);
9393
* /* response ==

clients/client-ec2/src/commands/DeleteSpotDatafeedSubscriptionCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ export interface DeleteSpotDatafeedSubscriptionCommandOutput extends __MetadataB
5959
* @example To cancel a Spot Instance data feed subscription
6060
* ```javascript
6161
* // This example deletes a Spot data feed subscription for the account.
62-
* const input = undefined;
62+
* const input = {};
6363
* const command = new DeleteSpotDatafeedSubscriptionCommand(input);
6464
* await client.send(command);
6565
* // example id: ec2-delete-spot-datafeed-subscription-1

clients/client-ec2/src/commands/DescribeAccountAttributesCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ export interface DescribeAccountAttributesCommandOutput extends DescribeAccountA
130130
* @example To describe all attributes for your AWS account
131131
* ```javascript
132132
* // This example describes the attributes for your AWS account.
133-
* const input = undefined;
133+
* const input = {};
134134
* const command = new DescribeAccountAttributesCommand(input);
135135
* const response = await client.send(command);
136136
* /* response ==

clients/client-ec2/src/commands/DescribeAddressesCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ export interface DescribeAddressesCommandOutput extends DescribeAddressesResult,
9494
* @example To describe your Elastic IP addresses
9595
* ```javascript
9696
* // This example describes your Elastic IP addresses.
97-
* const input = undefined;
97+
* const input = {};
9898
* const command = new DescribeAddressesCommand(input);
9999
* const response = await client.send(command);
100100
* /* response ==

clients/client-ec2/src/commands/DescribeAvailabilityZonesCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ export interface DescribeAvailabilityZonesCommandOutput extends DescribeAvailabi
9696
* @example To describe your Availability Zones
9797
* ```javascript
9898
* // This example describes the Availability Zones that are available to you. The response includes Availability Zones only for the current region.
99-
* const input = undefined;
99+
* const input = {};
100100
* const command = new DescribeAvailabilityZonesCommand(input);
101101
* const response = await client.send(command);
102102
* /* response ==

clients/client-ec2/src/commands/DescribeMovingAddressesCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ export interface DescribeMovingAddressesCommandOutput extends DescribeMovingAddr
8181
* @example To describe your moving addresses
8282
* ```javascript
8383
* // This example describes all of your moving Elastic IP addresses.
84-
* const input = undefined;
84+
* const input = {};
8585
* const command = new DescribeMovingAddressesCommand(input);
8686
* const response = await client.send(command);
8787
* /* response ==

clients/client-ec2/src/commands/DescribeRegionsCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ export interface DescribeRegionsCommandOutput extends DescribeRegionsResult, __M
7979
* @example To describe your regions
8080
* ```javascript
8181
* // This example describes all the regions that are available to you.
82-
* const input = undefined;
82+
* const input = {};
8383
* const command = new DescribeRegionsCommand(input);
8484
* const response = await client.send(command);
8585
* /* response ==

clients/client-ec2/src/commands/DescribeSpotDatafeedSubscriptionCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ export interface DescribeSpotDatafeedSubscriptionCommandOutput
7373
* @example To describe the datafeed for your AWS account
7474
* ```javascript
7575
* // This example describes the Spot Instance datafeed subscription for your AWS account.
76-
* const input = undefined;
76+
* const input = {};
7777
* const command = new DescribeSpotDatafeedSubscriptionCommand(input);
7878
* const response = await client.send(command);
7979
* /* response ==

clients/client-ec2/src/models/models_2.ts

-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ import {
3030
VpcAttachment,
3131
VpcPeeringConnection,
3232
} from "./models_0";
33-
3433
import {
3534
CarrierGateway,
3635
ClientVpnEndpointStatus,

clients/client-ec2/src/models/models_3.ts

-2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ import {
3636
VerifiedAccessTrustProvider,
3737
VerifiedAccessTrustProviderFilterSensitiveLog,
3838
} from "./models_0";
39-
4039
import {
4140
AttributeValue,
4241
BlockDeviceMapping,
@@ -71,7 +70,6 @@ import {
7170
TrafficType,
7271
TransportProtocol,
7372
} from "./models_1";
74-
7573
import {
7674
FleetStateCode,
7775
SubnetCidrReservation,

clients/client-ec2/src/models/models_4.ts

-3
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ import {
2424
TagSpecification,
2525
UserIdGroupPair,
2626
} from "./models_0";
27-
2827
import {
2928
AmdSevSnpSpecification,
3029
AttributeValue,
@@ -69,7 +68,6 @@ import {
6968
TargetCapacityUnitType,
7069
Tenancy,
7170
} from "./models_1";
72-
7371
import {
7472
NetworkInterface,
7573
NetworkInterfacePermission,
@@ -83,7 +81,6 @@ import {
8381
SpotInstanceStateFault,
8482
StorageTier,
8583
} from "./models_2";
86-
8784
import {
8885
ArchitectureValues,
8986
BootModeValues,

clients/client-ec2/src/models/models_5.ts

-4
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,7 @@ import {
3131
VpcIpv6CidrBlockAssociation,
3232
VpcPeeringConnection,
3333
} from "./models_0";
34-
3534
import { DiskImageFormat, InstanceRequirementsRequest, IpamResourceTag, Subnet, VolumeType, Vpc } from "./models_1";
36-
3735
import {
3836
ConnectionNotification,
3937
DnsEntry,
@@ -63,7 +61,6 @@ import {
6361
VpnConnectionFilterSensitiveLog,
6462
VpnGateway,
6563
} from "./models_2";
66-
6764
import {
6865
ExportTaskS3Location,
6966
FastLaunchLaunchTemplateSpecificationResponse,
@@ -79,7 +76,6 @@ import {
7976
StatisticType,
8077
VirtualizationType,
8178
} from "./models_3";
82-
8379
import { ArchitectureType, AttributeBooleanValue } from "./models_4";
8480

8581
/**

clients/client-ec2/src/models/models_6.ts

-5
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ import {
3737
VerifiedAccessTrustProvider,
3838
VerifiedAccessTrustProviderFilterSensitiveLog,
3939
} from "./models_0";
40-
4140
import {
4241
AttributeValue,
4342
BlockDeviceMapping,
@@ -74,7 +73,6 @@ import {
7473
TargetCapacityUnitType,
7574
VolumeType,
7675
} from "./models_1";
77-
7876
import {
7977
AutoAcceptSharedAttachmentsValue,
8078
DefaultRouteTableAssociationValue,
@@ -109,7 +107,6 @@ import {
109107
VpnEcmpSupportValue,
110108
VpnTunnelLogOptionsSpecification,
111109
} from "./models_2";
112-
113110
import {
114111
ArchitectureValues,
115112
BootModeValues,
@@ -130,7 +127,6 @@ import {
130127
TpmSupportValues,
131128
VirtualizationType,
132129
} from "./models_3";
133-
134130
import {
135131
AnalysisStatus,
136132
ArchitectureType,
@@ -155,7 +151,6 @@ import {
155151
SnapshotTaskDetail,
156152
SnapshotTaskDetailFilterSensitiveLog,
157153
} from "./models_4";
158-
159154
import {
160155
InstanceFamilyCreditSpecification,
161156
IpamComplianceStatus,

clients/client-ec2/src/models/models_7.ts

-5
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ import {
2020
TransitGatewayVpcAttachment,
2121
UnsuccessfulItem,
2222
} from "./models_0";
23-
2423
import {
2524
AmdSevSnpSpecification,
2625
BlockDeviceMapping,
@@ -38,11 +37,8 @@ import {
3837
ShutdownBehavior,
3938
SpotInstanceType,
4039
} from "./models_1";
41-
4240
import { SnapshotState, SSEType, TransitGatewayRoute } from "./models_2";
43-
4441
import { ClientVpnConnectionStatus, Filter } from "./models_3";
45-
4642
import {
4743
HttpTokensState,
4844
InstanceAttributeName,
@@ -62,7 +58,6 @@ import {
6258
SpotInstanceRequestFilterSensitiveLog,
6359
SpotPlacement,
6460
} from "./models_4";
65-
6661
import {
6762
CapacityReservationSpecification,
6863
InstanceMonitoring,

clients/client-elastic-beanstalk/src/commands/CreateStorageLocationCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ export interface CreateStorageLocationCommandOutput extends CreateStorageLocatio
7070
* @example To create a new environment for an application
7171
* ```javascript
7272
* // The following operation creates a new environment for version v1 of a java application named my-app:
73-
* const input = undefined;
73+
* const input = {};
7474
* const command = new CreateStorageLocationCommand(input);
7575
* const response = await client.send(command);
7676
* /* response ==

clients/client-elastic-beanstalk/src/commands/ListAvailableSolutionStacksCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ export interface ListAvailableSolutionStacksCommandOutput
6969
* @example To view solution stacks
7070
* ```javascript
7171
* // The following operation lists solution stacks for all currently available platform configurations and any that you have used in the past:
72-
* const input = undefined;
72+
* const input = {};
7373
* const command = new ListAvailableSolutionStacksCommand(input);
7474
* const response = await client.send(command);
7575
* /* response ==

clients/client-iam/src/commands/DeleteAccountPasswordPolicyCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export interface DeleteAccountPasswordPolicyCommandOutput extends __MetadataBear
6565
* @example To delete the current account password policy
6666
* ```javascript
6767
* // The following command removes the password policy from the current AWS account:
68-
* const input = undefined;
68+
* const input = {};
6969
* const command = new DeleteAccountPasswordPolicyCommand(input);
7070
* await client.send(command);
7171
* // example id: 9ddf755e-495c-49bc-ae3b-ea6cc9b8ebcf

clients/client-iam/src/commands/GetAccountPasswordPolicyCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ export interface GetAccountPasswordPolicyCommandOutput extends GetAccountPasswor
7878
* @example To see the current account password policy
7979
* ```javascript
8080
* // The following command displays details about the password policy for the current AWS account.
81-
* const input = undefined;
81+
* const input = {};
8282
* const command = new GetAccountPasswordPolicyCommand(input);
8383
* const response = await client.send(command);
8484
* /* response ==

clients/client-iam/src/commands/GetAccountSummaryCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export interface GetAccountSummaryCommandOutput extends GetAccountSummaryRespons
6565
* @example To get information about IAM entity quotas and usage in the current account
6666
* ```javascript
6767
* // The following command returns information about the IAM entity quotas and usage in the current AWS account.
68-
* const input = undefined;
68+
* const input = {};
6969
* const command = new GetAccountSummaryCommand(input);
7070
* const response = await client.send(command);
7171
* /* response ==

clients/client-inspector/src/commands/DescribeCrossAccountAccessRoleCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ export interface DescribeCrossAccountAccessRoleCommandOutput
6767
* @example Describte cross account access role
6868
* ```javascript
6969
* // Describes the IAM role that enables Amazon Inspector to access your AWS account.
70-
* const input = undefined;
70+
* const input = {};
7171
* const command = new DescribeCrossAccountAccessRoleCommand(input);
7272
* const response = await client.send(command);
7373
* /* response ==

clients/client-kms/src/commands/ListAliasesCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ export interface ListAliasesCommandOutput extends ListAliasesResponse, __Metadat
133133
* @example To list aliases
134134
* ```javascript
135135
* // The following example lists aliases.
136-
* const input = undefined;
136+
* const input = {};
137137
* const command = new ListAliasesCommand(input);
138138
* const response = await client.send(command);
139139
* /* response ==

clients/client-kms/src/commands/ListKeysCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ export interface ListKeysCommandOutput extends ListKeysResponse, __MetadataBeare
110110
* @example To list KMS keys
111111
* ```javascript
112112
* // The following example lists KMS keys.
113-
* const input = undefined;
113+
* const input = {};
114114
* const command = new ListKeysCommand(input);
115115
* const response = await client.send(command);
116116
* /* response ==

clients/client-organizations/src/commands/DescribeOrganizationCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ export interface DescribeOrganizationCommandOutput extends DescribeOrganizationR
100100
* @example To get information about an organization
101101
* ```javascript
102102
* // The following example shows how to request information about the current user's organization:/n/n
103-
* const input = undefined;
103+
* const input = {};
104104
* const command = new DescribeOrganizationCommand(input);
105105
* const response = await client.send(command);
106106
* /* response ==

clients/client-organizations/src/commands/LeaveOrganizationCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -455,7 +455,7 @@ export interface LeaveOrganizationCommandOutput extends __MetadataBearer {}
455455
* @example To leave an organization as a member account
456456
* ```javascript
457457
* // TThe following example shows how to remove your member account from an organization:
458-
* const input = undefined;
458+
* const input = {};
459459
* const command = new LeaveOrganizationCommand(input);
460460
* await client.send(command);
461461
* // example id: to-leave-an-organization-as-a-member-account-1472508784736

clients/client-organizations/src/commands/ListHandshakesForAccountCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ export interface ListHandshakesForAccountCommandOutput extends ListHandshakesFor
234234
* @example To retrieve a list of the handshakes sent to an account
235235
* ```javascript
236236
* // 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:
237-
* const input = undefined;
237+
* const input = {};
238238
* const command = new ListHandshakesForAccountCommand(input);
239239
* const response = await client.send(command);
240240
* /* response ==

clients/client-organizations/src/commands/ListHandshakesForOrganizationCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ export interface ListHandshakesForOrganizationCommandOutput
246246
* @example To retrieve a list of the handshakes associated with an organization
247247
* ```javascript
248248
* // The following example shows you how to get a list of handshakes associated with the current organization:
249-
* const input = undefined;
249+
* const input = {};
250250
* const command = new ListHandshakesForOrganizationCommand(input);
251251
* const response = await client.send(command);
252252
* /* response ==

0 commit comments

Comments
 (0)