Skip to content

Commit

Permalink
docs(client-ec2): Documentation updates for Amazon EC2.
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed May 1, 2024
1 parent 1142738 commit 044d712
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 12 deletions.
4 changes: 2 additions & 2 deletions clients/client-ec2/src/commands/DeleteTransitGatewayRouteTableCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ export interface DeleteTransitGatewayRouteTableCommandOutput
__MetadataBearer {}

/**
* <p>Deletes the specified transit gateway route table. You must disassociate the route table from any
* transit gateway route tables before you can delete it.</p>
* <p>Deletes the specified transit gateway route table. If there are any route tables associated with
* the transit gateway route table, you must first run <a>DisassociateRouteTable</a> before you can delete the transit gateway route table. This removes any route tables associated with the transit gateway route table.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
5 changes: 4 additions & 1 deletion clients/client-ec2/src/models/models_1.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7071,7 +7071,10 @@ export interface LaunchTemplateInstanceNetworkInterfaceSpecificationRequest {
Description?: string;

/**
* <p>The device index for the network interface attachment.</p>
* <p>The device index for the network interface attachment. Each network interface requires
* a device index. If you create a launch template that includes secondary network interfaces
* but not a primary network interface, then you must add a primary network interface as a
* launch parameter when you launch an instance from the template.</p>
* @public
*/
DeviceIndex?: number;
Expand Down
15 changes: 12 additions & 3 deletions clients/client-ec2/src/models/models_2.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5624,7 +5624,10 @@ export type VolumeState = (typeof VolumeState)[keyof typeof VolumeState];
*/
export interface Volume {
/**
* <p>Information about the volume attachments.</p>
* <note>
* <p>This parameter is not returned by CreateVolume.</p>
* </note>
* <p>Information about the volume attachments.</p>
* @public
*/
Attachments?: VolumeAttachment[];
Expand Down Expand Up @@ -5705,7 +5708,10 @@ export interface Volume {
VolumeType?: VolumeType;

/**
* <p>Indicates whether the volume was created using fast snapshot restore.</p>
* <note>
* <p>This parameter is not returned by CreateVolume.</p>
* </note>
* <p>Indicates whether the volume was created using fast snapshot restore.</p>
* @public
*/
FastRestored?: boolean;
Expand All @@ -5723,7 +5729,10 @@ export interface Volume {
Throughput?: number;

/**
* <p>Reserved for future use.</p>
* <note>
* <p>This parameter is not returned by CreateVolume.</p>
* </note>
* <p>Reserved for future use.</p>
* @public
*/
SseType?: SSEType;
Expand Down
7 changes: 7 additions & 0 deletions clients/client-ec2/src/models/models_5.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1687,6 +1687,13 @@ export interface DescribeTransitGatewaysRequest {
* <p>
* <code>transit-gateway-id</code> - The ID of the transit gateway.</p>
* </li>
* <li>
* <p>
* <code>tag-key </code>- The key/value combination of a tag assigned to the resource. Use the
* tag key in the filter name and the tag value as the filter value. For example, to
* find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify
* <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p>
* </li>
* </ul>
* @public
*/
Expand Down
12 changes: 6 additions & 6 deletions codegen/sdk-codegen/aws-models/ec2.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25555,7 +25555,7 @@
"target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableResult"
},
"traits": {
"smithy.api#documentation": "<p>Deletes the specified transit gateway route table. You must disassociate the route table from any\n transit gateway route tables before you can delete it.</p>"
"smithy.api#documentation": "<p>Deletes the specified transit gateway route table. If there are any route tables associated with\n the transit gateway route table, you must first run <a>DisassociateRouteTable</a> before you can delete the transit gateway route table. This removes any route tables associated with the transit gateway route table.</p>"
}
},
"com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncement": {
Expand Down Expand Up @@ -39646,7 +39646,7 @@
"Filters": {
"target": "com.amazonaws.ec2#FilterList",
"traits": {
"smithy.api#documentation": "<p>One or more filters. The possible values are:</p>\n <ul>\n <li>\n <p>\n <code>options.propagation-default-route-table-id</code> - The ID of the default propagation route table.</p>\n </li>\n <li>\n <p>\n <code>options.amazon-side-asn</code> - The private ASN for the Amazon side of a BGP session.</p>\n </li>\n <li>\n <p>\n <code>options.association-default-route-table-id</code> - The ID of the default association route table.</p>\n </li>\n <li>\n <p>\n <code>options.auto-accept-shared-attachments</code> - Indicates whether there is automatic acceptance of attachment requests (<code>enable</code> | <code>disable</code>).</p>\n </li>\n <li>\n <p>\n <code>options.default-route-table-association</code> - Indicates whether resource attachments are automatically \n associated with the default association route table (<code>enable</code> | <code>disable</code>).</p>\n </li>\n <li>\n <p>\n <code>options.default-route-table-propagation</code> - Indicates whether resource attachments automatically propagate \n routes to the default propagation route table (<code>enable</code> | <code>disable</code>).</p>\n </li>\n <li>\n <p>\n <code>options.dns-support</code> - Indicates whether DNS support is enabled (<code>enable</code> | <code>disable</code>).</p>\n </li>\n <li>\n <p>\n <code>options.vpn-ecmp-support</code> - Indicates whether Equal Cost Multipath Protocol support is enabled (<code>enable</code> | <code>disable</code>).</p>\n </li>\n <li>\n <p>\n <code>owner-id</code> - The ID of the Amazon Web Services account that owns the transit gateway.</p>\n </li>\n <li>\n <p>\n <code>state</code> - The state of the transit gateway (<code>available</code> | <code>deleted</code> | <code>deleting</code> | <code>modifying</code> | <code>pending</code>).</p>\n </li>\n <li>\n <p>\n <code>transit-gateway-id</code> - The ID of the transit gateway.</p>\n </li>\n </ul>",
"smithy.api#documentation": "<p>One or more filters. The possible values are:</p>\n <ul>\n <li>\n <p>\n <code>options.propagation-default-route-table-id</code> - The ID of the default propagation route table.</p>\n </li>\n <li>\n <p>\n <code>options.amazon-side-asn</code> - The private ASN for the Amazon side of a BGP session.</p>\n </li>\n <li>\n <p>\n <code>options.association-default-route-table-id</code> - The ID of the default association route table.</p>\n </li>\n <li>\n <p>\n <code>options.auto-accept-shared-attachments</code> - Indicates whether there is automatic acceptance of attachment requests (<code>enable</code> | <code>disable</code>).</p>\n </li>\n <li>\n <p>\n <code>options.default-route-table-association</code> - Indicates whether resource attachments are automatically \n associated with the default association route table (<code>enable</code> | <code>disable</code>).</p>\n </li>\n <li>\n <p>\n <code>options.default-route-table-propagation</code> - Indicates whether resource attachments automatically propagate \n routes to the default propagation route table (<code>enable</code> | <code>disable</code>).</p>\n </li>\n <li>\n <p>\n <code>options.dns-support</code> - Indicates whether DNS support is enabled (<code>enable</code> | <code>disable</code>).</p>\n </li>\n <li>\n <p>\n <code>options.vpn-ecmp-support</code> - Indicates whether Equal Cost Multipath Protocol support is enabled (<code>enable</code> | <code>disable</code>).</p>\n </li>\n <li>\n <p>\n <code>owner-id</code> - The ID of the Amazon Web Services account that owns the transit gateway.</p>\n </li>\n <li>\n <p>\n <code>state</code> - The state of the transit gateway (<code>available</code> | <code>deleted</code> | <code>deleting</code> | <code>modifying</code> | <code>pending</code>).</p>\n </li>\n <li>\n <p>\n <code>transit-gateway-id</code> - The ID of the transit gateway.</p>\n </li>\n <li>\n <p>\n <code>tag-key </code>- The key/value combination of a tag assigned to the resource. Use the\n tag key in the filter name and the tag value as the filter value. For example, to\n find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify\n <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p>\n </li>\n </ul>",
"smithy.api#xmlName": "Filter"
}
},
Expand Down Expand Up @@ -71008,7 +71008,7 @@
"DeviceIndex": {
"target": "com.amazonaws.ec2#Integer",
"traits": {
"smithy.api#documentation": "<p>The device index for the network interface attachment.</p>"
"smithy.api#documentation": "<p>The device index for the network interface attachment. Each network interface requires\n a device index. If you create a launch template that includes secondary network interfaces \n but not a primary network interface, then you must add a primary network interface as a \n launch parameter when you launch an instance from the template.</p>"
}
},
"Groups": {
Expand Down Expand Up @@ -104748,7 +104748,7 @@
"target": "com.amazonaws.ec2#VolumeAttachmentList",
"traits": {
"aws.protocols#ec2QueryName": "AttachmentSet",
"smithy.api#documentation": "<p>Information about the volume attachments.</p>",
"smithy.api#documentation": "<note>\n <p>This parameter is not returned by CreateVolume.</p>\n </note>\n <p>Information about the volume attachments.</p>",
"smithy.api#xmlName": "attachmentSet"
}
},
Expand Down Expand Up @@ -104852,7 +104852,7 @@
"target": "com.amazonaws.ec2#Boolean",
"traits": {
"aws.protocols#ec2QueryName": "FastRestored",
"smithy.api#documentation": "<p>Indicates whether the volume was created using fast snapshot restore.</p>",
"smithy.api#documentation": "<note>\n <p>This parameter is not returned by CreateVolume.</p>\n </note>\n <p>Indicates whether the volume was created using fast snapshot restore.</p>",
"smithy.api#xmlName": "fastRestored"
}
},
Expand All @@ -104876,7 +104876,7 @@
"target": "com.amazonaws.ec2#SSEType",
"traits": {
"aws.protocols#ec2QueryName": "SseType",
"smithy.api#documentation": "<p>Reserved for future use.</p>",
"smithy.api#documentation": "<note>\n <p>This parameter is not returned by CreateVolume.</p>\n </note>\n <p>Reserved for future use.</p>",
"smithy.api#xmlName": "sseType"
}
}
Expand Down

0 comments on commit 044d712

Please sign in to comment.