- 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.
GetBillScenarioCommand
Retrieves details of a specific bill scenario.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { BCMPricingCalculatorClient, GetBillScenarioCommand } from "@aws-sdk/client-bcm-pricing-calculator"; // ES Modules import
// const { BCMPricingCalculatorClient, GetBillScenarioCommand } = require("@aws-sdk/client-bcm-pricing-calculator"); // CommonJS import
const client = new BCMPricingCalculatorClient(config);
const input = { // GetBillScenarioRequest
identifier: "STRING_VALUE", // required
};
const command = new GetBillScenarioCommand(input);
const response = await client.send(command);
// { // GetBillScenarioResponse
// id: "STRING_VALUE", // required
// name: "STRING_VALUE",
// billInterval: { // BillInterval
// start: new Date("TIMESTAMP"),
// end: new Date("TIMESTAMP"),
// },
// status: "READY" || "LOCKED" || "FAILED",
// createdAt: new Date("TIMESTAMP"),
// expiresAt: new Date("TIMESTAMP"),
// failureMessage: "STRING_VALUE",
// };
GetBillScenarioCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
identifier Required | string | undefined | The unique identifier of the bill scenario to retrieve. |
GetBillScenarioCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
id Required | string | undefined | The unique identifier of the retrieved bill scenario. |
billInterval | BillInterval | undefined | The time period covered by the bill scenario. |
createdAt | Date | undefined | The timestamp when the bill scenario was created. |
expiresAt | Date | undefined | The timestamp when the bill scenario will expire. |
failureMessage | string | undefined | An error message if the bill scenario retrieval failed. |
name | string | undefined | The name of the retrieved bill scenario. |
status | BillScenarioStatus | undefined | The current status of the bill scenario. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
DataUnavailableException | client | The requested data is currently unavailable. |
ResourceNotFoundException | client | The specified resource was not found. |
AccessDeniedException | client | You do not have sufficient access to perform this action. |
InternalServerException | server | An internal error has occurred. Retry your request, but if the problem persists, contact Amazon Web Services support. |
ThrottlingException | client | The request was denied due to request throttling. |
ValidationException | client | The input provided fails to satisfy the constraints specified by an Amazon Web Services service. |
BCMPricingCalculatorServiceException | Base exception class for all service exceptions from BCMPricingCalculator service. |