Skip to content

Commit

Permalink
feat(client-elastic-inference): Updated public documentation for the …
Browse files Browse the repository at this point in the history
…Describe and Tagging APIs.
  • Loading branch information
awstools committed Apr 4, 2023
1 parent f96b649 commit e28258e
Show file tree
Hide file tree
Showing 12 changed files with 520 additions and 392 deletions.
5 changes: 5 additions & 0 deletions clients/client-elastic-inference/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ AWS SDK for JavaScript ElasticInference Client for Node.js, Browser and React Na
<p>
Elastic Inference public APIs.
</p>
<p>
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.
After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.
However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
</p>

## Installing

Expand Down
35 changes: 35 additions & 0 deletions clients/client-elastic-inference/src/ElasticInference.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,23 @@ import { ElasticInferenceClient } from "./ElasticInferenceClient";
* <p>
* Elastic Inference public APIs.
* </p>
* <p>
* February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.
* After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.
* However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
* </p>
*/
export class ElasticInference extends ElasticInferenceClient {
/**
* @public
* <p>
* Describes the locations in which a given accelerator type or set of types is present in a given region.
* </p>
* <p>
* February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.
* After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.
* However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
* </p>
*/
public describeAcceleratorOfferings(
args: DescribeAcceleratorOfferingsCommandInput,
Expand Down Expand Up @@ -76,6 +86,11 @@ export class ElasticInference extends ElasticInferenceClient {
* <p>
* Describes information over a provided set of accelerators belonging to an account.
* </p>
* <p>
* February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.
* After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.
* However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
* </p>
*/
public describeAccelerators(
args: DescribeAcceleratorsCommandInput,
Expand Down Expand Up @@ -111,6 +126,11 @@ export class ElasticInference extends ElasticInferenceClient {
* <p>
* Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.
* </p>
* <p>
* February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.
* After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.
* However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
* </p>
*/
public describeAcceleratorTypes(
args: DescribeAcceleratorTypesCommandInput,
Expand Down Expand Up @@ -146,6 +166,11 @@ export class ElasticInference extends ElasticInferenceClient {
* <p>
* Returns all tags of an Elastic Inference Accelerator.
* </p>
* <p>
* February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.
* After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.
* However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
* </p>
*/
public listTagsForResource(
args: ListTagsForResourceCommandInput,
Expand Down Expand Up @@ -181,6 +206,11 @@ export class ElasticInference extends ElasticInferenceClient {
* <p>
* Adds the specified tags to an Elastic Inference Accelerator.
* </p>
* <p>
* February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.
* After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.
* However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
* </p>
*/
public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
Expand Down Expand Up @@ -210,6 +240,11 @@ export class ElasticInference extends ElasticInferenceClient {
* <p>
* Removes the specified tags from an Elastic Inference Accelerator.
* </p>
* <p>
* February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.
* After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.
* However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
* </p>
*/
public untagResource(
args: UntagResourceCommandInput,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,11 @@ export interface ElasticInferenceClientResolvedConfig extends ElasticInferenceCl
* <p>
* Elastic Inference public APIs.
* </p>
* <p>
* February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.
* After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.
* However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
* </p>
*/
export class ElasticInferenceClient extends __Client<
__HttpHandlerOptions,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,19 @@ export interface DescribeAcceleratorOfferingsCommandOutput
* <p>
* Describes the locations in which a given accelerator type or set of types is present in a given region.
* </p>
* <p>
* February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.
* After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.
* However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
* </p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { ElasticInferenceClient, DescribeAcceleratorOfferingsCommand } from "@aws-sdk/client-elastic-inference"; // ES Modules import
* // const { ElasticInferenceClient, DescribeAcceleratorOfferingsCommand } = require("@aws-sdk/client-elastic-inference"); // CommonJS import
* const client = new ElasticInferenceClient(config);
* const input = { // DescribeAcceleratorOfferingsRequest
* locationType: "STRING_VALUE", // required
* locationType: "region" || "availability-zone" || "availability-zone-id", // required
* acceleratorTypes: [ // AcceleratorTypeNameList
* "STRING_VALUE",
* ],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ export interface DescribeAcceleratorTypesCommandOutput extends DescribeAccelerat
* <p>
* Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.
* </p>
* <p>
* February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.
* After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.
* However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
* </p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ export interface DescribeAcceleratorsCommandOutput extends DescribeAcceleratorsR
* <p>
* Describes information over a provided set of accelerators belonging to an account.
* </p>
* <p>
* February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.
* After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.
* However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
* </p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
* <p>
* Returns all tags of an Elastic Inference Accelerator.
* </p>
* <p>
* February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.
* After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.
* However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
* </p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ export interface TagResourceCommandOutput extends TagResourceResult, __MetadataB
* <p>
* Adds the specified tags to an Elastic Inference Accelerator.
* </p>
* <p>
* February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.
* After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.
* However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
* </p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ export interface UntagResourceCommandOutput extends UntagResourceResult, __Metad
* <p>
* Removes the specified tags from an Elastic Inference Accelerator.
* </p>
* <p>
* February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.
* After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.
* However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
* </p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
35 changes: 18 additions & 17 deletions clients/client-elastic-inference/src/endpoint/ruleset.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,25 @@ import { RuleSetObject } from "@aws-sdk/util-endpoints";
or see "smithy.rules#endpointRuleSet"
in codegen/sdk-codegen/aws-models/elastic-inference.json */

const p="required",
q="fn",
r="argv",
s="ref";
const a="PartitionResult",
const q="required",
r="fn",
s="argv",
t="ref";
const a="isSet",
b="tree",
c="error",
d="endpoint",
e={[p]:false,"type":"String"},
f={[p]:true,"default":false,"type":"Boolean"},
g={[s]:"Endpoint"},
h={[q]:"booleanEquals",[r]:[{[s]:"UseFIPS"},true]},
i={[q]:"booleanEquals",[r]:[{[s]:"UseDualStack"},true]},
j={},
k={[q]:"booleanEquals",[r]:[true,{[q]:"getAttr",[r]:[{[s]:a},"supportsFIPS"]}]},
l={[q]:"booleanEquals",[r]:[true,{[q]:"getAttr",[r]:[{[s]:a},"supportsDualStack"]}]},
m=[g],
n=[h],
o=[i];
const _data={version:"1.0",parameters:{Region:e,UseDualStack:f,UseFIPS:f,Endpoint:e},rules:[{conditions:[{[q]:"aws.partition",[r]:[{[s]:"Region"}],assign:a}],type:b,rules:[{conditions:[{[q]:"isSet",[r]:m},{[q]:"parseURL",[r]:m,assign:"url"}],type:b,rules:[{conditions:n,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:g,properties:j,headers:j},type:d}]}]},{conditions:[h,i],type:b,rules:[{conditions:[k,l],type:b,rules:[{endpoint:{url:"https://api.elastic-inference-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:j,headers:j},type:d}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:n,type:b,rules:[{conditions:[k],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://api.elastic-inference-fips.{Region}.{PartitionResult#dnsSuffix}",properties:j,headers:j},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:o,type:b,rules:[{conditions:[l],type:b,rules:[{endpoint:{url:"https://api.elastic-inference.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:j,headers:j},type:d}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{endpoint:{url:"https://api.elastic-inference.{Region}.{PartitionResult#dnsSuffix}",properties:j,headers:j},type:d}]}]};
e="PartitionResult",
f={[q]:false,"type":"String"},
g={[q]:true,"default":false,"type":"Boolean"},
h={[t]:"Endpoint"},
i={[r]:"booleanEquals",[s]:[{[t]:"UseFIPS"},true]},
j={[r]:"booleanEquals",[s]:[{[t]:"UseDualStack"},true]},
k={},
l={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsFIPS"]}]},
m={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsDualStack"]}]},
n=[i],
o=[j],
p=[{[t]:"Region"}];
const _data={version:"1.0",parameters:{Region:f,UseDualStack:g,UseFIPS:g,Endpoint:f},rules:[{conditions:[{[r]:a,[s]:[h]}],type:b,rules:[{conditions:n,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:h,properties:k,headers:k},type:d}]}]},{type:b,rules:[{conditions:[{[r]:a,[s]:p}],type:b,rules:[{conditions:[{[r]:"aws.partition",[s]:p,assign:e}],type:b,rules:[{conditions:[i,j],type:b,rules:[{conditions:[l,m],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://api.elastic-inference-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:n,type:b,rules:[{conditions:[l],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://api.elastic-inference-fips.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:o,type:b,rules:[{conditions:[m],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://api.elastic-inference.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{type:b,rules:[{endpoint:{url:"https://api.elastic-inference.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}]};
export const ruleSet: RuleSetObject = _data;
12 changes: 11 additions & 1 deletion clients/client-elastic-inference/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,18 @@ export interface AcceleratorType {

/**
* @public
* @enum
*/
export type LocationType = "availability-zone" | "availability-zone-id" | "region";
export const LocationType = {
availability_zone: "availability-zone",
availability_zone_id: "availability-zone-id",
region: "region",
} as const;

/**
* @public
*/
export type LocationType = (typeof LocationType)[keyof typeof LocationType];

/**
* @public
Expand Down
Loading

0 comments on commit e28258e

Please sign in to comment.