- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateLongTermPricingCommand
Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SnowballClient, CreateLongTermPricingCommand } from "@aws-sdk/client-snowball"; // ES Modules import
// const { SnowballClient, CreateLongTermPricingCommand } = require("@aws-sdk/client-snowball"); // CommonJS import
const client = new SnowballClient(config);
const input = { // CreateLongTermPricingRequest
LongTermPricingType: "OneYear" || "ThreeYear" || "OneMonth", // required
IsLongTermPricingAutoRenew: true || false,
SnowballType: "STANDARD" || "EDGE" || "EDGE_C" || "EDGE_CG" || "EDGE_S" || "SNC1_HDD" || "SNC1_SSD" || "V3_5C" || "V3_5S" || "RACK_5U_C", // required
};
const command = new CreateLongTermPricingCommand(input);
const response = await client.send(command);
// { // CreateLongTermPricingResult
// LongTermPricingId: "STRING_VALUE",
// };
CreateLongTermPricingCommand Input
See CreateLongTermPricingCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
LongTermPricingTypeRequired | LongTermPricingType | undefined | The type of long-term pricing option you want for the device, either 1-year or 3-year long-term pricing. |
SnowballTypeRequired | SnowballType | undefined | The type of Snow Family devices to use for the long-term pricing job. |
IsLongTermPricingAutoRenew | boolean | undefined | Specifies whether the current long-term pricing type for the device should be renewed. |
CreateLongTermPricingCommand Output
See CreateLongTermPricingCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
LongTermPricingId | string | undefined | The ID of the long-term pricing type for the device. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InvalidResourceException | client | The specified resource can't be found. Check the information you provided in your last request, and try again. |
| SnowballServiceException | Base exception class for all service exceptions from Snowball service. |