ListLongTermPricingCommand

Suggest an Edit

Lists all long-term pricing types.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SnowballClient, ListLongTermPricingCommand } from "@aws-sdk/client-snowball"; // ES Modules import
// const { SnowballClient, ListLongTermPricingCommand } = require("@aws-sdk/client-snowball"); // CommonJS import
const client = new SnowballClient(config);
const input = { // ListLongTermPricingRequest
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListLongTermPricingCommand(input);
const response = await client.send(command);
// { // ListLongTermPricingResult
//   LongTermPricingEntries: [ // LongTermPricingEntryList
//     { // LongTermPricingListEntry
//       LongTermPricingId: "STRING_VALUE",
//       LongTermPricingEndDate: new Date("TIMESTAMP"),
//       LongTermPricingStartDate: new Date("TIMESTAMP"),
//       LongTermPricingType: "OneYear" || "ThreeYear" || "OneMonth",
//       CurrentActiveJob: "STRING_VALUE",
//       ReplacementJob: "STRING_VALUE",
//       IsLongTermPricingAutoRenew: true || false,
//       LongTermPricingStatus: "STRING_VALUE",
//       SnowballType: "STANDARD" || "EDGE" || "EDGE_C" || "EDGE_CG" || "EDGE_S" || "SNC1_HDD" || "SNC1_SSD" || "V3_5C" || "V3_5S" || "RACK_5U_C",
//       JobIds: [ // LongTermPricingAssociatedJobIdList
//         "STRING_VALUE",
//       ],
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListLongTermPricingCommand Input

See ListLongTermPricingCommandInput for more details

Parameter
Type
Description
MaxResults
number | undefined

The maximum number of ListLongTermPricing objects to return.

NextToken
string | undefined

Because HTTP requests are stateless, this is the starting point for your next list of ListLongTermPricing to return.

ListLongTermPricingCommand Output

See ListLongTermPricingCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
LongTermPricingEntries
LongTermPricingListEntry[] | undefined

Each LongTermPricingEntry object contains a status, ID, and other information about the LongTermPricing type.

NextToken
string | undefined

Because HTTP requests are stateless, this is the starting point for your next list of returned ListLongTermPricing list.

Throws

Name
Fault
Details
InvalidNextTokenException
client

The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

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.