From cd827e78b43f73434cc5b52071b0eec966e8a262 Mon Sep 17 00:00:00 2001 From: awstools Date: Tue, 15 Aug 2023 18:16:30 +0000 Subject: [PATCH] feat(client-ec2): Documentation updates for Elastic Compute Cloud (EC2). --- .../CreateSubnetCidrReservationCommand.ts | 4 +- .../DeleteLaunchTemplateVersionsCommand.ts | 13 +- clients/client-ec2/src/models/models_1.ts | 4 +- clients/client-ec2/src/models/models_2.ts | 30 +-- clients/client-ec2/src/models/models_3.ts | 172 ++++++++++++++++-- clients/client-ec2/src/models/models_6.ts | 1 + codegen/sdk-codegen/aws-models/ec2.json | 20 +- 7 files changed, 188 insertions(+), 56 deletions(-) diff --git a/clients/client-ec2/src/commands/CreateSubnetCidrReservationCommand.ts b/clients/client-ec2/src/commands/CreateSubnetCidrReservationCommand.ts index 42c5428d75c3..61e98164b271 100644 --- a/clients/client-ec2/src/commands/CreateSubnetCidrReservationCommand.ts +++ b/clients/client-ec2/src/commands/CreateSubnetCidrReservationCommand.ts @@ -36,7 +36,9 @@ export interface CreateSubnetCidrReservationCommandOutput extends CreateSubnetCi /** * @public - *

Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide.

+ *

Creates a subnet CIDR reservation. For more information, see Subnet CIDR reservations + * in the Amazon Virtual Private Cloud User Guide and Assign prefixes + * to network interfaces in the Amazon Elastic Compute Cloud User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DeleteLaunchTemplateVersionsCommand.ts b/clients/client-ec2/src/commands/DeleteLaunchTemplateVersionsCommand.ts index 9a79b49609e2..b59b2ce086d4 100644 --- a/clients/client-ec2/src/commands/DeleteLaunchTemplateVersionsCommand.ts +++ b/clients/client-ec2/src/commands/DeleteLaunchTemplateVersionsCommand.ts @@ -38,10 +38,15 @@ export interface DeleteLaunchTemplateVersionsCommandOutput /** * @public - *

Deletes one or more versions of a launch template. You cannot delete the default - * version of a launch template; you must first assign a different version as the default. - * If the default version is the only version for the launch template, you must delete the - * entire launch template using DeleteLaunchTemplate.

+ *

Deletes one or more versions of a launch template.

+ *

You can't delete the default version of a launch template; you must first assign a + * different version as the default. If the default version is the only version for the + * launch template, you must delete the entire launch template using DeleteLaunchTemplate.

+ *

You can delete up to 200 launch template versions in a single request. To delete more + * than 200 versions in a single request, use DeleteLaunchTemplate, which + * deletes the launch template and all of its versions.

+ *

For more information, see Delete a launch template version in the EC2 User + * Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/models/models_1.ts b/clients/client-ec2/src/models/models_1.ts index 8aefc269ec2b..ec1b7d81cd58 100644 --- a/clients/client-ec2/src/models/models_1.ts +++ b/clients/client-ec2/src/models/models_1.ts @@ -3773,9 +3773,7 @@ export interface CreateFlowLogsRequest { * field. For more information about the available fields, see Flow log * records in the Amazon VPC User Guide or Transit Gateway Flow Log * records in the Amazon Web Services Transit Gateway Guide.

- *

Specify the fields using the $\{field-id\} format, separated by spaces. For - * the CLI, surround this parameter value with single quotes on Linux or - * double quotes on Windows.

+ *

Specify the fields using the $\{field-id\} format, separated by spaces.

*/ LogFormat?: string; diff --git a/clients/client-ec2/src/models/models_2.ts b/clients/client-ec2/src/models/models_2.ts index c69be1a72659..57e8d4275045 100644 --- a/clients/client-ec2/src/models/models_2.ts +++ b/clients/client-ec2/src/models/models_2.ts @@ -1579,24 +1579,17 @@ export interface CreateSubnetCidrReservationRequest { /** * @public - *

The type of reservation.

- *

The following are valid values:

+ *

The type of reservation. The reservation type determines how the reserved IP addresses are + * assigned to resources.

* */ @@ -1604,9 +1597,7 @@ export interface CreateSubnetCidrReservationRequest { /** * @public - *

The - * description - * to assign to the subnet CIDR reservation.

+ *

The description to assign to the subnet CIDR reservation.

*/ Description?: string; @@ -1662,10 +1653,7 @@ export interface SubnetCidrReservation { /** * @public - *

The - * description - * assigned to the subnet CIDR - * reservation.

+ *

The description assigned to the subnet CIDR reservation.

*/ Description?: string; @@ -2082,6 +2070,7 @@ export interface CreateTrafficMirrorSessionRequest { * set this value to 100, then the first 100 bytes that meet the filter criteria are copied to * the target.

*

If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.

+ *

For sessions with Network Load Balancer (NLB) Traffic Mirror targets the default PacketLength will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will result in an error response.

*/ PacketLength?: number; @@ -8027,7 +8016,8 @@ export interface DeleteLaunchTemplateVersionsRequest { /** * @public - *

The version numbers of one or more launch template versions to delete.

+ *

The version numbers of one or more launch template versions to delete. You can specify + * up to 200 launch template version numbers.

*/ Versions: string[] | undefined; } diff --git a/clients/client-ec2/src/models/models_3.ts b/clients/client-ec2/src/models/models_3.ts index 688a32f005b6..e6227ad65a76 100644 --- a/clients/client-ec2/src/models/models_3.ts +++ b/clients/client-ec2/src/models/models_3.ts @@ -9473,7 +9473,7 @@ export interface DescribeInstancesRequest { *

* block-device-mapping.attach-time - The attach time for an EBS * volume mapped to the instance, for example, - * 2010-09-15T17:15:20.000Z.

+ * 2022-09-15T17:15:20.000Z.

* *
  • *

    @@ -9482,9 +9482,9 @@ export interface DescribeInstancesRequest { *

    • *
  • *

    - * block-device-mapping.device-name - The device name specified in the - * block device mapping (for example, /dev/sdh or - * xvdh).

    + * block-device-mapping.device-name - The device name specified in + * the block device mapping (for example, /dev/sdh or + * xvdh).

    *
    • *
  • *

    @@ -9499,13 +9499,40 @@ export interface DescribeInstancesRequest { *

    • *
  • *

    + * boot-mode - The boot mode that was specified by the AMI + * (legacy-bios | uefi | + * uefi-preferred).

    + *
    • + *
  • + *

    * capacity-reservation-id - The ID of the Capacity Reservation into which the * instance was launched.

    *
    • *
  • *

    - * client-token - The idempotency token you provided when you launched - * the instance.

    + * capacity-reservation-specification.capacity-reservation-preference + * - The instance's Capacity Reservation preference (open | none).

    + *
    • + *
  • + *

    + * capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id + * - The ID of the targeted Capacity Reservation.

    + *
    • + *
  • + *

    + * capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn + * - The ARN of the targeted Capacity Reservation group.

    + *
    • + *
  • + *

    + * client-token - The idempotency token you provided when you + * launched the instance.

    + *
    • + *
  • + *

    + * current-instance-boot-mode - The boot mode that is used to launch + * the instance at launch or start (legacy-bios | + * uefi).

    *
    • *
  • *

    @@ -9513,9 +9540,24 @@ export interface DescribeInstancesRequest { *

    • *
  • *

    + * ebs-optimized - A Boolean that indicates whether the instance is + * optimized for Amazon EBS I/O.

    + *
    • + *
  • + *

    + * ena-support - A Boolean that indicates whether the instance is + * enabled for enhanced networking with ENA.

    + *
    • + *
  • + *

    + * enclave-options.enabled - A Boolean that indicates whether the + * instance is enabled for Amazon Web Services Nitro Enclaves.

    + *
    • + *
  • + *

    * hibernation-options.configured - A Boolean that indicates whether * the instance is enabled for hibernation. A value of true means that - * the instance is enabled for hibernation.

    + * the instance is enabled for hibernation.

    *
    • *
  • *

    @@ -9535,6 +9577,16 @@ export interface DescribeInstancesRequest { *

    • *
  • *

    + * iam-instance-profile.id - The instance profile associated with + * the instance. Specified as an ID.

    + *
    • + *
  • + *

    + * iam-instance-profile.name - The instance profile associated with + * the instance. Specified as an name.

    + *
    • + *
  • + *

    * image-id - The ID of the image used to launch the * instance.

    *
    • @@ -9583,6 +9635,10 @@ export interface DescribeInstancesRequest { * *
  • *

    + * ipv6-address - The IPv6 address of the instance.

    + *
    • + *
  • + *

    * kernel-id - The kernel ID.

    *
    • *
  • @@ -9606,14 +9662,12 @@ export interface DescribeInstancesRequest { *
    • *
  • *

    - * metadata-options.http-tokens - The metadata request authorization - * state (optional | required)

    + * license-pool -

    *
    • *
  • *

    - * metadata-options.http-put-response-hop-limit - The HTTP metadata - * request put response hop limit (integer, possible values 1 to - * 64)

    + * maintenance-options.auto-recovery - The current automatic + * recovery behavior of the instance (disabled | default).

    *
    • *
  • *

    @@ -9623,19 +9677,40 @@ export interface DescribeInstancesRequest { *

    • *
  • *

    + * metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 + * endpoint is enabled (disabled | enabled).

    + *
    • + *
  • + *

    + * metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 + * endpoint is enabled (disabled | enabled).

    + *
    • + *
  • + *

    + * metadata-options.http-put-response-hop-limit - The HTTP metadata + * request put response hop limit (integer, possible values 1 to + * 64)

    + *
    • + *
  • + *

    + * metadata-options.http-tokens - The metadata request authorization + * state (optional | required)

    + *
    • + *
  • + *

    * metadata-options.instance-metadata-tags - The status of access to * instance tags from the instance metadata (enabled | * disabled)

    *
    • *
  • *

    - * monitoring-state - Indicates whether detailed monitoring is - * enabled (disabled | enabled).

    + * metadata-options.state - The state of the metadata option changes + * (pending | applied).

    *
    • *
  • *

    - * network-interface.addresses.private-ip-address - The private IPv4 - * address associated with the network interface.

    + * monitoring-state - Indicates whether detailed monitoring is + * enabled (disabled | enabled).

    *
    • *
  • *

    @@ -9644,6 +9719,11 @@ export interface DescribeInstancesRequest { *

    • *
  • *

    + * network-interface.addresses.private-ip-address - The private IPv4 + * address associated with the network interface.

    + *
    • + *
  • + *

    * network-interface.addresses.association.public-ip - The ID of the * association of an Elastic IP address (IPv4) with a network interface.

    *
    • @@ -9814,11 +9894,43 @@ export interface DescribeInstancesRequest { * *
  • *

    + * platform-details - The platform (Linux/UNIX | + * Red Hat BYOL Linux | Red Hat Enterprise Linux | + * Red Hat Enterprise Linux with HA | Red Hat Enterprise + * Linux with SQL Server Standard and HA | Red Hat Enterprise + * Linux with SQL Server Enterprise and HA | Red Hat Enterprise + * Linux with SQL Server Standard | Red Hat Enterprise Linux with + * SQL Server Web | Red Hat Enterprise Linux with SQL Server + * Enterprise | SQL Server Enterprise | SQL Server + * Standard | SQL Server Web | SUSE Linux | + * Ubuntu Pro | Windows | Windows BYOL | + * Windows with SQL Server Enterprise | Windows with SQL + * Server Standard | Windows with SQL Server Web).

    + *
    • + *
  • + *

    * private-dns-name - The private IPv4 DNS name of the * instance.

    *
    • *
  • *

    + * private-dns-name-options.enable-resource-name-dns-a-record - A + * Boolean that indicates whether to respond to DNS queries for instance hostnames + * with DNS A records.

    + *
    • + *
  • + *

    + * private-dns-name-options.enable-resource-name-dns-aaaa-record - A + * Boolean that indicates whether to respond to DNS queries for instance hostnames + * with DNS AAAA records.

    + *
    • + *
  • + *

    + * private-dns-name-options.hostname-type - The type of hostname + * (ip-name | resource-name).

    + *
    • + *
  • + *

    * private-ip-address - The private IPv4 address of the * instance.

    *
    • @@ -9829,8 +9941,8 @@ export interface DescribeInstancesRequest { * *
  • *

    - * product-code.type - The type of product code (devpay | - * marketplace).

    + * product-code.type - The type of product code (devpay + * | marketplace).

    *
    • *
  • *

    @@ -9910,6 +10022,30 @@ export interface DescribeInstancesRequest { *

    • *
  • *

    + * tpm-support - Indicates if the instance is configured for + * NitroTPM support (v2.0).

    + *
    • + *
  • + *

    + * usage-operation - The usage operation value for the instance + * (RunInstances | RunInstances:00g0 | + * RunInstances:0010 | RunInstances:1010 | + * RunInstances:1014 | RunInstances:1110 | + * RunInstances:0014 | RunInstances:0210 | + * RunInstances:0110 | RunInstances:0100 | + * RunInstances:0004 | RunInstances:0200 | + * RunInstances:000g | RunInstances:0g00 | + * RunInstances:0002 | RunInstances:0800 | + * RunInstances:0102 | RunInstances:0006 | + * RunInstances:0202).

    + *
    • + *
  • + *

    + * usage-operation-update-time - The time that the usage operation + * was last updated, for example, 2022-09-15T17:15:20.000Z.

    + *
    • + *
  • + *

    * virtualization-type - The virtualization type of the instance * (paravirtual | hvm).

    *
    • diff --git a/clients/client-ec2/src/models/models_6.ts b/clients/client-ec2/src/models/models_6.ts index ec3418610f52..70046ebd1302 100644 --- a/clients/client-ec2/src/models/models_6.ts +++ b/clients/client-ec2/src/models/models_6.ts @@ -4102,6 +4102,7 @@ export interface ModifyTrafficMirrorSessionRequest { /** * @public *

    The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.

    + *

    For sessions with Network Load Balancer (NLB) traffic mirror targets, the default PacketLength will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will result in an error response.

    */ PacketLength?: number; diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index 3ffeb0eea4ae..3daeeda1ee5a 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -14707,7 +14707,7 @@ "LogFormat": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

    The fields to include in the flow log record. List the fields in the order in which\n they should appear. If you omit this parameter, the flow log is created using the\n default format. If you specify this parameter, you must include at least one\n field. For more information about the available fields, see Flow log\n records in the Amazon VPC User Guide or Transit Gateway Flow Log\n records in the Amazon Web Services Transit Gateway Guide.

    \n

    Specify the fields using the ${field-id} format, separated by spaces. For\n the CLI, surround this parameter value with single quotes on Linux or\n double quotes on Windows.

    " + "smithy.api#documentation": "

    The fields to include in the flow log record. List the fields in the order in which\n they should appear. If you omit this parameter, the flow log is created using the\n default format. If you specify this parameter, you must include at least one\n field. For more information about the available fields, see Flow log\n records in the Amazon VPC User Guide or Transit Gateway Flow Log\n records in the Amazon Web Services Transit Gateway Guide.

    \n

    Specify the fields using the ${field-id} format, separated by spaces.

    " } }, "TagSpecifications": { @@ -18124,7 +18124,7 @@ "target": "com.amazonaws.ec2#CreateSubnetCidrReservationResult" }, "traits": { - "smithy.api#documentation": "

    Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide.

    " + "smithy.api#documentation": "

    Creates a subnet CIDR reservation. For more information, see Subnet CIDR reservations \n in the Amazon Virtual Private Cloud User Guide and Assign prefixes \n to network interfaces in the Amazon Elastic Compute Cloud User Guide.

    " } }, "com.amazonaws.ec2#CreateSubnetCidrReservationRequest": { @@ -18150,14 +18150,14 @@ "target": "com.amazonaws.ec2#SubnetCidrReservationType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

    The type of reservation.

    \n

    The following are valid values:

    \n ", + "smithy.api#documentation": "

    The type of reservation. The reservation type determines how the reserved IP addresses are \n assigned to resources.

    \n ", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

    The\n description\n to assign to the subnet CIDR reservation.

    " + "smithy.api#documentation": "

    The description to assign to the subnet CIDR reservation.

    " } }, "DryRun": { @@ -18581,7 +18581,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

    The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do\n not specify this parameter when you want to mirror the entire packet. To mirror a subset of\n the packet, set this to the length (in bytes) that you want to mirror. For example, if you\n set this value to 100, then the first 100 bytes that meet the filter criteria are copied to\n the target.

    \n

    If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.

    " + "smithy.api#documentation": "

    The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do\n not specify this parameter when you want to mirror the entire packet. To mirror a subset of\n the packet, set this to the length (in bytes) that you want to mirror. For example, if you\n set this value to 100, then the first 100 bytes that meet the filter criteria are copied to\n the target.

    \n

    If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.

    \n

    For sessions with Network Load Balancer (NLB) Traffic Mirror targets the default PacketLength will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will result in an error response.

    " } }, "SessionNumber": { @@ -22682,7 +22682,7 @@ "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResult" }, "traits": { - "smithy.api#documentation": "

    Deletes one or more versions of a launch template. You cannot delete the default\n version of a launch template; you must first assign a different version as the default.\n If the default version is the only version for the launch template, you must delete the\n entire launch template using DeleteLaunchTemplate.

    ", + "smithy.api#documentation": "

    Deletes one or more versions of a launch template.

    \n

    You can't delete the default version of a launch template; you must first assign a\n different version as the default. If the default version is the only version for the\n launch template, you must delete the entire launch template using DeleteLaunchTemplate.

    \n

    You can delete up to 200 launch template versions in a single request. To delete more\n than 200 versions in a single request, use DeleteLaunchTemplate, which\n deletes the launch template and all of its versions.

    \n

    For more information, see Delete a launch template version in the EC2 User\n Guide.

    ", "smithy.api#examples": [ { "title": "To delete a launch template version", @@ -22732,7 +22732,7 @@ "target": "com.amazonaws.ec2#VersionStringList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

    The version numbers of one or more launch template versions to delete.

    ", + "smithy.api#documentation": "

    The version numbers of one or more launch template versions to delete. You can specify\n up to 200 launch template version numbers.

    ", "smithy.api#required": {}, "smithy.api#xmlName": "LaunchTemplateVersion" } @@ -31394,7 +31394,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

    The filters.

    \n ", + "smithy.api#documentation": "

    The filters.

    \n ", "smithy.api#xmlName": "Filter" } }, @@ -73830,7 +73830,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

    The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.

    " + "smithy.api#documentation": "

    The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.

    \n

    For sessions with Network Load Balancer (NLB) traffic mirror targets, the default PacketLength will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will result in an error response.

    " } }, "SessionNumber": { @@ -94127,7 +94127,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

    The\n description\n assigned to the subnet CIDR\n reservation.

    ", + "smithy.api#documentation": "

    The description assigned to the subnet CIDR reservation.

    ", "smithy.api#xmlName": "description" } },