From c155b9e2ca52f81da287efb0c184de8f5388884d Mon Sep 17 00:00:00 2001 From: awstools Date: Tue, 2 Jul 2024 18:18:31 +0000 Subject: [PATCH] feat(client-ec2): Documentation updates for Elastic Compute Cloud (EC2). --- .../ModifyInstancePlacementCommand.ts | 2 +- clients/client-ec2/src/models/models_0.ts | 36 ++++++++++++++++++- clients/client-ec2/src/models/models_1.ts | 14 ++++---- clients/client-ec2/src/models/models_2.ts | 5 ++- clients/client-ec2/src/models/models_5.ts | 2 +- clients/client-ec2/src/models/models_6.ts | 6 ++-- clients/client-ec2/src/models/models_7.ts | 9 ++--- codegen/sdk-codegen/aws-models/ec2.json | 22 +++++++----- 8 files changed, 70 insertions(+), 26 deletions(-) diff --git a/clients/client-ec2/src/commands/ModifyInstancePlacementCommand.ts b/clients/client-ec2/src/commands/ModifyInstancePlacementCommand.ts index 48dee9beeee6..45a464bdffef 100644 --- a/clients/client-ec2/src/commands/ModifyInstancePlacementCommand.ts +++ b/clients/client-ec2/src/commands/ModifyInstancePlacementCommand.ts @@ -65,7 +65,7 @@ export interface ModifyInstancePlacementCommandOutput extends ModifyInstancePlac * GroupName: "STRING_VALUE", * HostId: "STRING_VALUE", * InstanceId: "STRING_VALUE", // required - * Tenancy: "dedicated" || "host", + * Tenancy: "default" || "dedicated" || "host", * PartitionNumber: Number("int"), * HostResourceGroupArn: "STRING_VALUE", * GroupId: "STRING_VALUE", diff --git a/clients/client-ec2/src/models/models_0.ts b/clients/client-ec2/src/models/models_0.ts index 4a418f015fa7..26a5d7c947fb 100644 --- a/clients/client-ec2/src/models/models_0.ts +++ b/clients/client-ec2/src/models/models_0.ts @@ -3101,7 +3101,41 @@ export interface ByoipCidr { StatusMessage?: string; /** - *

The state of the address pool.

+ *

The state of the address range.

+ * * @public */ State?: ByoipCidrState; diff --git a/clients/client-ec2/src/models/models_1.ts b/clients/client-ec2/src/models/models_1.ts index 8ebe24dc3cfc..24fb1611c41a 100644 --- a/clients/client-ec2/src/models/models_1.ts +++ b/clients/client-ec2/src/models/models_1.ts @@ -2224,7 +2224,7 @@ export interface InstanceRequirementsRequest { * selects instance types with your attributes, it will exclude instance types whose price * exceeds your specified threshold.

*

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

- *

If you set DesiredCapacityType to vcpu or + *

If you set TargetCapacityUnitType to vcpu or * memory-mib, the price protection threshold is based on the per vCPU or per * memory price instead of the per instance price.

* @@ -3615,7 +3615,7 @@ export interface InstanceRequirements { * selects instance types with your attributes, it will exclude instance types whose price * exceeds your specified threshold.

*

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

- *

If you set DesiredCapacityType to vcpu or + *

If you set TargetCapacityUnitType to vcpu or * memory-mib, the price protection threshold is based on the per vCPU or per * memory price instead of the per instance price.

* @@ -4566,16 +4566,18 @@ export interface CreateInstanceConnectEndpointRequest { SecurityGroupIds?: string[]; /** - *

Indicates whether your client's IP address is preserved as the source. The value is true or false.

+ *

Indicates whether the client IP address is preserved as the source. The following are the possible values.

*
    *
  • - *

    If true, your client's IP address is used when you connect to a resource.

    + *

    + * true - Use the client IP address as the source.

    *
    • *
  • - *

    If false, the elastic network interface IP address is used when you connect to a resource.

    + *

    + * false - Use the network interface IP address as the source.

    *
    • *
- *

Default: true + *

Default: false *

* @public */ diff --git a/clients/client-ec2/src/models/models_2.ts b/clients/client-ec2/src/models/models_2.ts index 38e017c576fa..1484a5bab2dc 100644 --- a/clients/client-ec2/src/models/models_2.ts +++ b/clients/client-ec2/src/models/models_2.ts @@ -5495,7 +5495,10 @@ export interface CreateVolumeRequest { KmsKeyId?: string; /** - *

The Amazon Resource Name (ARN) of the Outpost.

+ *

The Amazon Resource Name (ARN) of the Outpost on which to create the volume.

+ *

If you intend to use a volume with an instance running on an outpost, then you must + * create the volume on the same outpost as the instance. You can't use a volume created + * in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around.

* @public */ OutpostArn?: string; diff --git a/clients/client-ec2/src/models/models_5.ts b/clients/client-ec2/src/models/models_5.ts index 75cf7982c878..460dca0690bb 100644 --- a/clients/client-ec2/src/models/models_5.ts +++ b/clients/client-ec2/src/models/models_5.ts @@ -2703,7 +2703,7 @@ export interface DescribeVolumesRequest { Filters?: Filter[]; /** - *

The volume IDs.

+ *

The volume IDs. If not specified, then all volumes are included in the response.

* @public */ VolumeIds?: string[]; diff --git a/clients/client-ec2/src/models/models_6.ts b/clients/client-ec2/src/models/models_6.ts index 37625c83a1b7..8546cec42480 100644 --- a/clients/client-ec2/src/models/models_6.ts +++ b/clients/client-ec2/src/models/models_6.ts @@ -5385,8 +5385,9 @@ export interface ModifyInstanceAttributeRequest { SriovNetSupport?: AttributeValue; /** - *

Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you - * can load the text from a file. Otherwise, you must provide base64-encoded text.

+ *

Changes the instance's user data to the specified value. User data must be base64-encoded. + * Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. + * For more information, see Work with instance user data.

* @public */ UserData?: BlobAttributeValue; @@ -6012,6 +6013,7 @@ export interface ModifyInstanceMetadataOptionsResult { */ export const HostTenancy = { dedicated: "dedicated", + default: "default", host: "host", } as const; diff --git a/clients/client-ec2/src/models/models_7.ts b/clients/client-ec2/src/models/models_7.ts index d6b79665b394..7fb756e5116d 100644 --- a/clients/client-ec2/src/models/models_7.ts +++ b/clients/client-ec2/src/models/models_7.ts @@ -3188,12 +3188,9 @@ export interface RunInstancesRequest { SubnetId?: string; /** - *

The user data script to make available to the instance. For more information, see - * Run - * commands on your Amazon EC2 instance at launch in the Amazon EC2 User - * Guide. If you are using a command line tool, base64-encoding is performed - * for you, and you can load the text from a file. Otherwise, you must provide - * base64-encoded text. User data is limited to 16 KB.

+ *

The user data to make available to the instance. User data must be base64-encoded. + * Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. + * For more information, see Work with instance user data.

* @public */ UserData?: string; diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index e0c7f2eb518a..b298cf3f7261 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -9556,7 +9556,7 @@ "target": "com.amazonaws.ec2#ByoipCidrState", "traits": { "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the address pool.

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

The state of the address range.

\n
    \n
  • \n

    \n advertised: The address range is being advertised to the internet by Amazon Web Services.

    \n
    • \n
  • \n

    \n deprovisioned: The address range is deprovisioned.

    \n
    • \n
  • \n

    \n failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.

    \n
    • \n
  • \n

    \n failed-provision: The request to provision the address range was unsuccessful.

    \n
    • \n
  • \n

    \n pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.

    \n
    • \n
  • \n

    \n pending-provision: You’ve submitted a request to provision an address range and it's pending.

    \n
    • \n
  • \n

    \n provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.

    \n
    • \n
  • \n

    \n provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.

    \n
    • \n
", "smithy.api#xmlName": "state" } }, @@ -15615,7 +15615,7 @@ "PreserveClientIp": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether your client's IP address is preserved as the source. The value is true or false.

\n
    \n
  • \n

    If true, your client's IP address is used when you connect to a resource.

    \n
    • \n
  • \n

    If false, the elastic network interface IP address is used when you connect to a resource.

    \n
    • \n
\n

Default: true\n

" + "smithy.api#documentation": "

Indicates whether the client IP address is preserved as the source. The following are the possible values.

\n
    \n
  • \n

    \n true - Use the client IP address as the source.

    \n
    • \n
  • \n

    \n false - Use the network interface IP address as the source.

    \n
    • \n
\n

Default: false\n

" } }, "ClientToken": { @@ -20962,7 +20962,7 @@ "OutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost on which to create the volume.

\n

If you intend to use a volume with an instance running on an outpost, then you must \n create the volume on the same outpost as the instance. You can't use a volume created \n in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around.

" } }, "Size": { @@ -40849,7 +40849,7 @@ "VolumeIds": { "target": "com.amazonaws.ec2#VolumeIdStringList", "traits": { - "smithy.api#documentation": "

The volume IDs.

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

The volume IDs. If not specified, then all volumes are included in the response.

", "smithy.api#xmlName": "VolumeId" } }, @@ -55504,6 +55504,12 @@ "com.amazonaws.ec2#HostTenancy": { "type": "enum", "members": { + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + }, "dedicated": { "target": "smithy.api#Unit", "traits": { @@ -60543,7 +60549,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice", - "smithy.api#documentation": "

[Price protection] The price protection threshold for Spot Instances, as a percentage of an\n identified On-Demand price. The identified On-Demand price is the price of the lowest\n priced current generation C, M, or R instance type with your specified attributes. If no\n current generation C, M, or R instance type matches your attributes, then the identified\n price is from the lowest priced current generation instance types, and failing that, from\n the lowest priced previous generation instance types that match your attributes. When Amazon EC2\n selects instance types with your attributes, it will exclude instance types whose price\n exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per vCPU or per\n memory price instead of the per instance price.

\n \n

Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you\n don't specify either, Amazon EC2 will automatically apply optimal price protection to\n consistently select from a wide range of instance types. To indicate no price protection\n threshold for Spot Instances, meaning you want to consider all instance types that match your\n attributes, include one of these parameters and specify a high value, such as\n 999999.

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

[Price protection] The price protection threshold for Spot Instances, as a percentage of an\n identified On-Demand price. The identified On-Demand price is the price of the lowest\n priced current generation C, M, or R instance type with your specified attributes. If no\n current generation C, M, or R instance type matches your attributes, then the identified\n price is from the lowest priced current generation instance types, and failing that, from\n the lowest priced previous generation instance types that match your attributes. When Amazon EC2\n selects instance types with your attributes, it will exclude instance types whose price\n exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is based on the per vCPU or per\n memory price instead of the per instance price.

\n \n

Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you\n don't specify either, Amazon EC2 will automatically apply optimal price protection to\n consistently select from a wide range of instance types. To indicate no price protection\n threshold for Spot Instances, meaning you want to consider all instance types that match your\n attributes, include one of these parameters and specify a high value, such as\n 999999.

\n ", "smithy.api#xmlName": "maxSpotPriceAsPercentageOfOptimalOnDemandPrice" } } @@ -60708,7 +60714,7 @@ "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

[Price protection] The price protection threshold for Spot Instances, as a percentage of an\n identified On-Demand price. The identified On-Demand price is the price of the lowest\n priced current generation C, M, or R instance type with your specified attributes. If no\n current generation C, M, or R instance type matches your attributes, then the identified\n price is from the lowest priced current generation instance types, and failing that, from\n the lowest priced previous generation instance types that match your attributes. When Amazon EC2\n selects instance types with your attributes, it will exclude instance types whose price\n exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per vCPU or per\n memory price instead of the per instance price.

\n \n

Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you\n don't specify either, Amazon EC2 will automatically apply optimal price protection to\n consistently select from a wide range of instance types. To indicate no price protection\n threshold for Spot Instances, meaning you want to consider all instance types that match your\n attributes, include one of these parameters and specify a high value, such as\n 999999.

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

[Price protection] The price protection threshold for Spot Instances, as a percentage of an\n identified On-Demand price. The identified On-Demand price is the price of the lowest\n priced current generation C, M, or R instance type with your specified attributes. If no\n current generation C, M, or R instance type matches your attributes, then the identified\n price is from the lowest priced current generation instance types, and failing that, from\n the lowest priced previous generation instance types that match your attributes. When Amazon EC2\n selects instance types with your attributes, it will exclude instance types whose price\n exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is based on the per vCPU or per\n memory price instead of the per instance price.

\n \n

Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you\n don't specify either, Amazon EC2 will automatically apply optimal price protection to\n consistently select from a wide range of instance types. To indicate no price protection\n threshold for Spot Instances, meaning you want to consider all instance types that match your\n attributes, include one of these parameters and specify a high value, such as\n 999999.

\n " } } }, @@ -75311,7 +75317,7 @@ "target": "com.amazonaws.ec2#BlobAttributeValue", "traits": { "aws.protocols#ec2QueryName": "UserData", - "smithy.api#documentation": "

Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you\n can load the text from a file. Otherwise, you must provide base64-encoded text.

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

Changes the instance's user data to the specified value. User data must be base64-encoded.\n Depending on the tool or SDK that you're using, the base64-encoding might be performed for you.\n For more information, see Work with instance user data.

", "smithy.api#xmlName": "userData" } }, @@ -92306,7 +92312,7 @@ "UserData": { "target": "com.amazonaws.ec2#RunInstancesUserData", "traits": { - "smithy.api#documentation": "

The user data script to make available to the instance. For more information, see\n Run\n commands on your Amazon EC2 instance at launch in the Amazon EC2 User\n Guide. If you are using a command line tool, base64-encoding is performed\n for you, and you can load the text from a file. Otherwise, you must provide\n base64-encoded text. User data is limited to 16 KB.

" + "smithy.api#documentation": "

The user data to make available to the instance. User data must be base64-encoded.\n Depending on the tool or SDK that you're using, the base64-encoding might be performed for you.\n For more information, see Work with instance user data.

" } }, "AdditionalInfo": {