import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ListBenefitAllocationsInput, ListBenefitAllocationsOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link ListBenefitAllocationsCommand}. */ export interface ListBenefitAllocationsCommandInput extends ListBenefitAllocationsInput { } /** * @public * * The output of {@link ListBenefitAllocationsCommand}. */ export interface ListBenefitAllocationsCommandOutput extends ListBenefitAllocationsOutput, __MetadataBearer { } declare const ListBenefitAllocationsCommand_base: { new (input: ListBenefitAllocationsCommandInput): import("@smithy/core/client").CommandImpl; new (input: ListBenefitAllocationsCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Retrieves a paginated list of benefit allocations based on specified filter criteria.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { PartnerCentralBenefitsClient, ListBenefitAllocationsCommand } from "@aws-sdk/client-partnercentral-benefits"; // ES Modules import * // const { PartnerCentralBenefitsClient, ListBenefitAllocationsCommand } = require("@aws-sdk/client-partnercentral-benefits"); // CommonJS import * // import type { PartnerCentralBenefitsClientConfig } from "@aws-sdk/client-partnercentral-benefits"; * const config = {}; // type is PartnerCentralBenefitsClientConfig * const client = new PartnerCentralBenefitsClient(config); * const input = { // ListBenefitAllocationsInput * Catalog: "STRING_VALUE", // required * FulfillmentTypes: [ // FulfillmentTypes * "CREDITS" || "CASH" || "ACCESS", * ], * BenefitIdentifiers: [ // BenefitIdentifiers * "STRING_VALUE", * ], * BenefitApplicationIdentifiers: [ // BenefitApplicationIdentifierList * "STRING_VALUE", * ], * Status: [ // BenefitAllocationStatusList * "ACTIVE" || "INACTIVE" || "FULFILLED", * ], * MaxResults: Number("int"), * NextToken: "STRING_VALUE", * }; * const command = new ListBenefitAllocationsCommand(input); * const response = await client.send(command); * // { // ListBenefitAllocationsOutput * // BenefitAllocationSummaries: [ // BenefitAllocationSummaries * // { // BenefitAllocationSummary * // Id: "STRING_VALUE", * // Catalog: "STRING_VALUE", * // Arn: "STRING_VALUE", * // Status: "ACTIVE" || "INACTIVE" || "FULFILLED", * // StatusReason: "STRING_VALUE", * // Name: "STRING_VALUE", * // BenefitId: "STRING_VALUE", * // BenefitApplicationId: "STRING_VALUE", * // FulfillmentTypes: [ // FulfillmentTypes * // "CREDITS" || "CASH" || "ACCESS", * // ], * // CreatedAt: new Date("TIMESTAMP"), * // ExpiresAt: new Date("TIMESTAMP"), * // ApplicableBenefitIds: [ // BenefitIds * // "STRING_VALUE", * // ], * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param ListBenefitAllocationsCommandInput - {@link ListBenefitAllocationsCommandInput} * @returns {@link ListBenefitAllocationsCommandOutput} * @see {@link ListBenefitAllocationsCommandInput} for command's `input` shape. * @see {@link ListBenefitAllocationsCommandOutput} for command's `response` shape. * @see {@link PartnerCentralBenefitsClientResolvedConfig | config} for PartnerCentralBenefitsClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

Thrown when the caller does not have sufficient permissions to perform the requested operation.

* * @throws {@link InternalServerException} (server fault) *

Thrown when an unexpected error occurs on the server side during request processing.

* * @throws {@link ResourceNotFoundException} (client fault) *

Thrown when the requested resource cannot be found or does not exist.

* * @throws {@link ThrottlingException} (client fault) *

Thrown when the request rate exceeds the allowed limits and the request is being throttled.

* * @throws {@link ValidationException} (client fault) *

Thrown when the request contains invalid parameters or fails input validation requirements.

* * @throws {@link PartnerCentralBenefitsServiceException} *

Base exception class for all service exceptions from PartnerCentralBenefits service.

* * * @public */ export declare class ListBenefitAllocationsCommand extends ListBenefitAllocationsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ListBenefitAllocationsInput; output: ListBenefitAllocationsOutput; }; sdk: { input: ListBenefitAllocationsCommandInput; output: ListBenefitAllocationsCommandOutput; }; }; }