@aws-sdk/client-braket 3.936.0 → 3.939.0

package/dist-types/commands/CreateSpendingLimitCommand.d.ts

@@ -0,0 +1,98 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BraketClient";
+import { CreateSpendingLimitRequest, CreateSpendingLimitResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreateSpendingLimitCommand}.
+ */
+export interface CreateSpendingLimitCommandInput extends CreateSpendingLimitRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateSpendingLimitCommand}.
+ */
+export interface CreateSpendingLimitCommandOutput extends CreateSpendingLimitResponse, __MetadataBearer {
+}
+declare const CreateSpendingLimitCommand_base: {
+    new (input: CreateSpendingLimitCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSpendingLimitCommandInput, CreateSpendingLimitCommandOutput, BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: CreateSpendingLimitCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSpendingLimitCommandInput, CreateSpendingLimitCommandOutput, BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Creates a spending limit for a specified quantum device. Spending limits help you control costs by setting maximum amounts that can be spent on quantum computing tasks within a specified time period. Simulators do not support spending limits.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BraketClient, CreateSpendingLimitCommand } from "@aws-sdk/client-braket"; // ES Modules import
+ * // const { BraketClient, CreateSpendingLimitCommand } = require("@aws-sdk/client-braket"); // CommonJS import
+ * // import type { BraketClientConfig } from "@aws-sdk/client-braket";
+ * const config = {}; // type is BraketClientConfig
+ * const client = new BraketClient(config);
+ * const input = { // CreateSpendingLimitRequest
+ *   clientToken: "STRING_VALUE", // required
+ *   deviceArn: "STRING_VALUE", // required
+ *   spendingLimit: "STRING_VALUE", // required
+ *   timePeriod: { // TimePeriod
+ *     startAt: new Date("TIMESTAMP"), // required
+ *     endAt: new Date("TIMESTAMP"), // required
+ *   },
+ *   tags: { // TagsMap
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ * };
+ * const command = new CreateSpendingLimitCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateSpendingLimitResponse
+ * //   spendingLimitArn: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param CreateSpendingLimitCommandInput - {@link CreateSpendingLimitCommandInput}
+ * @returns {@link CreateSpendingLimitCommandOutput}
+ * @see {@link CreateSpendingLimitCommandInput} for command's `input` shape.
+ * @see {@link CreateSpendingLimitCommandOutput} for command's `response` shape.
+ * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient permissions to perform this action.</p>
+ *
+ * @throws {@link DeviceRetiredException} (client fault)
+ *  <p>The specified device has been retired.</p>
+ *
+ * @throws {@link InternalServiceException} (server fault)
+ *  <p>The request failed because of an unknown error.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The API throttling rate limit is exceeded.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
+ *
+ * @throws {@link BraketServiceException}
+ * <p>Base exception class for all service exceptions from Braket service.</p>
+ *
+ *
+ * @public
+ */
+export declare class CreateSpendingLimitCommand extends CreateSpendingLimitCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateSpendingLimitRequest;
+            output: CreateSpendingLimitResponse;
+        };
+        sdk: {
+            input: CreateSpendingLimitCommandInput;
+            output: CreateSpendingLimitCommandOutput;
+        };
+    };
+}

package/dist-types/commands/DeleteSpendingLimitCommand.d.ts

@@ -0,0 +1,87 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BraketClient";
+import { DeleteSpendingLimitRequest, DeleteSpendingLimitResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteSpendingLimitCommand}.
+ */
+export interface DeleteSpendingLimitCommandInput extends DeleteSpendingLimitRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteSpendingLimitCommand}.
+ */
+export interface DeleteSpendingLimitCommandOutput extends DeleteSpendingLimitResponse, __MetadataBearer {
+}
+declare const DeleteSpendingLimitCommand_base: {
+    new (input: DeleteSpendingLimitCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteSpendingLimitCommandInput, DeleteSpendingLimitCommandOutput, BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: DeleteSpendingLimitCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteSpendingLimitCommandInput, DeleteSpendingLimitCommandOutput, BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Deletes an existing spending limit. This operation permanently removes the spending limit and cannot be undone. After deletion, the associated device becomes unrestricted for spending.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BraketClient, DeleteSpendingLimitCommand } from "@aws-sdk/client-braket"; // ES Modules import
+ * // const { BraketClient, DeleteSpendingLimitCommand } = require("@aws-sdk/client-braket"); // CommonJS import
+ * // import type { BraketClientConfig } from "@aws-sdk/client-braket";
+ * const config = {}; // type is BraketClientConfig
+ * const client = new BraketClient(config);
+ * const input = { // DeleteSpendingLimitRequest
+ *   spendingLimitArn: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteSpendingLimitCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteSpendingLimitCommandInput - {@link DeleteSpendingLimitCommandInput}
+ * @returns {@link DeleteSpendingLimitCommandOutput}
+ * @see {@link DeleteSpendingLimitCommandInput} for command's `input` shape.
+ * @see {@link DeleteSpendingLimitCommandOutput} for command's `response` shape.
+ * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient permissions to perform this action.</p>
+ *
+ * @throws {@link InternalServiceException} (server fault)
+ *  <p>The request failed because of an unknown error.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource was not found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The API throttling rate limit is exceeded.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
+ *
+ * @throws {@link BraketServiceException}
+ * <p>Base exception class for all service exceptions from Braket service.</p>
+ *
+ *
+ * @public
+ */
+export declare class DeleteSpendingLimitCommand extends DeleteSpendingLimitCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DeleteSpendingLimitRequest;
+            output: {};
+        };
+        sdk: {
+            input: DeleteSpendingLimitCommandInput;
+            output: DeleteSpendingLimitCommandOutput;
+        };
+    };
+}

package/dist-types/commands/SearchSpendingLimitsCommand.d.ts

@@ -0,0 +1,114 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BraketClient";
+import { SearchSpendingLimitsRequest, SearchSpendingLimitsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link SearchSpendingLimitsCommand}.
+ */
+export interface SearchSpendingLimitsCommandInput extends SearchSpendingLimitsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link SearchSpendingLimitsCommand}.
+ */
+export interface SearchSpendingLimitsCommandOutput extends SearchSpendingLimitsResponse, __MetadataBearer {
+}
+declare const SearchSpendingLimitsCommand_base: {
+    new (input: SearchSpendingLimitsCommandInput): import("@smithy/smithy-client").CommandImpl<SearchSpendingLimitsCommandInput, SearchSpendingLimitsCommandOutput, BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [SearchSpendingLimitsCommandInput]): import("@smithy/smithy-client").CommandImpl<SearchSpendingLimitsCommandInput, SearchSpendingLimitsCommandOutput, BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Searches and lists spending limits based on specified filters. This operation supports pagination and allows filtering by various criteria to find specific spending limits. We recommend using pagination to ensure that the operation returns quickly and successfully.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BraketClient, SearchSpendingLimitsCommand } from "@aws-sdk/client-braket"; // ES Modules import
+ * // const { BraketClient, SearchSpendingLimitsCommand } = require("@aws-sdk/client-braket"); // CommonJS import
+ * // import type { BraketClientConfig } from "@aws-sdk/client-braket";
+ * const config = {}; // type is BraketClientConfig
+ * const client = new BraketClient(config);
+ * const input = { // SearchSpendingLimitsRequest
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ *   filters: [ // SearchSpendingLimitsFilterList
+ *     { // SearchSpendingLimitsFilter
+ *       name: "STRING_VALUE", // required
+ *       values: [ // String256List // required
+ *         "STRING_VALUE",
+ *       ],
+ *       operator: "STRING_VALUE", // required
+ *     },
+ *   ],
+ * };
+ * const command = new SearchSpendingLimitsCommand(input);
+ * const response = await client.send(command);
+ * // { // SearchSpendingLimitsResponse
+ * //   spendingLimits: [ // SpendingLimitSummaryList // required
+ * //     { // SpendingLimitSummary
+ * //       spendingLimitArn: "STRING_VALUE", // required
+ * //       deviceArn: "STRING_VALUE", // required
+ * //       timePeriod: { // TimePeriod
+ * //         startAt: new Date("TIMESTAMP"), // required
+ * //         endAt: new Date("TIMESTAMP"), // required
+ * //       },
+ * //       spendingLimit: "STRING_VALUE", // required
+ * //       queuedSpend: "STRING_VALUE", // required
+ * //       totalSpend: "STRING_VALUE", // required
+ * //       createdAt: new Date("TIMESTAMP"), // required
+ * //       updatedAt: new Date("TIMESTAMP"), // required
+ * //       tags: { // TagsMap
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param SearchSpendingLimitsCommandInput - {@link SearchSpendingLimitsCommandInput}
+ * @returns {@link SearchSpendingLimitsCommandOutput}
+ * @see {@link SearchSpendingLimitsCommandInput} for command's `input` shape.
+ * @see {@link SearchSpendingLimitsCommandOutput} for command's `response` shape.
+ * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient permissions to perform this action.</p>
+ *
+ * @throws {@link InternalServiceException} (server fault)
+ *  <p>The request failed because of an unknown error.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The API throttling rate limit is exceeded.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
+ *
+ * @throws {@link BraketServiceException}
+ * <p>Base exception class for all service exceptions from Braket service.</p>
+ *
+ *
+ * @public
+ */
+export declare class SearchSpendingLimitsCommand extends SearchSpendingLimitsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: SearchSpendingLimitsRequest;
+            output: SearchSpendingLimitsResponse;
+        };
+        sdk: {
+            input: SearchSpendingLimitsCommandInput;
+            output: SearchSpendingLimitsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateSpendingLimitCommand.d.ts

@@ -0,0 +1,93 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BraketClient";
+import { UpdateSpendingLimitRequest, UpdateSpendingLimitResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateSpendingLimitCommand}.
+ */
+export interface UpdateSpendingLimitCommandInput extends UpdateSpendingLimitRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateSpendingLimitCommand}.
+ */
+export interface UpdateSpendingLimitCommandOutput extends UpdateSpendingLimitResponse, __MetadataBearer {
+}
+declare const UpdateSpendingLimitCommand_base: {
+    new (input: UpdateSpendingLimitCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSpendingLimitCommandInput, UpdateSpendingLimitCommandOutput, BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateSpendingLimitCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSpendingLimitCommandInput, UpdateSpendingLimitCommandOutput, BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates an existing spending limit. You can modify the spending amount or time period. Changes take effect immediately.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BraketClient, UpdateSpendingLimitCommand } from "@aws-sdk/client-braket"; // ES Modules import
+ * // const { BraketClient, UpdateSpendingLimitCommand } = require("@aws-sdk/client-braket"); // CommonJS import
+ * // import type { BraketClientConfig } from "@aws-sdk/client-braket";
+ * const config = {}; // type is BraketClientConfig
+ * const client = new BraketClient(config);
+ * const input = { // UpdateSpendingLimitRequest
+ *   spendingLimitArn: "STRING_VALUE", // required
+ *   clientToken: "STRING_VALUE", // required
+ *   spendingLimit: "STRING_VALUE",
+ *   timePeriod: { // TimePeriod
+ *     startAt: new Date("TIMESTAMP"), // required
+ *     endAt: new Date("TIMESTAMP"), // required
+ *   },
+ * };
+ * const command = new UpdateSpendingLimitCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UpdateSpendingLimitCommandInput - {@link UpdateSpendingLimitCommandInput}
+ * @returns {@link UpdateSpendingLimitCommandOutput}
+ * @see {@link UpdateSpendingLimitCommandInput} for command's `input` shape.
+ * @see {@link UpdateSpendingLimitCommandOutput} for command's `response` shape.
+ * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient permissions to perform this action.</p>
+ *
+ * @throws {@link InternalServiceException} (server fault)
+ *  <p>The request failed because of an unknown error.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource was not found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The API throttling rate limit is exceeded.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
+ *
+ * @throws {@link BraketServiceException}
+ * <p>Base exception class for all service exceptions from Braket service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateSpendingLimitCommand extends UpdateSpendingLimitCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateSpendingLimitRequest;
+            output: {};
+        };
+        sdk: {
+            input: UpdateSpendingLimitCommandInput;
+            output: UpdateSpendingLimitCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -2,6 +2,8 @@ export * from "./CancelJobCommand";
 export * from "./CancelQuantumTaskCommand";
 export * from "./CreateJobCommand";
 export * from "./CreateQuantumTaskCommand";
+export * from "./CreateSpendingLimitCommand";
+export * from "./DeleteSpendingLimitCommand";
 export * from "./GetDeviceCommand";
 export * from "./GetJobCommand";
 export * from "./GetQuantumTaskCommand";
@@ -9,5 +11,7 @@ export * from "./ListTagsForResourceCommand";
 export * from "./SearchDevicesCommand";
 export * from "./SearchJobsCommand";
 export * from "./SearchQuantumTasksCommand";
+export * from "./SearchSpendingLimitsCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
+export * from "./UpdateSpendingLimitCommand";

package/dist-types/index.d.ts

@@ -10,6 +10,7 @@ export type { RuntimeExtension } from "./runtimeExtensions";
 export type { BraketExtensionConfiguration } from "./extensionConfiguration";
 export * from "./commands";
 export * from "./pagination";
+export * from "./models/enums";
 export * from "./models/errors";
 export type * from "./models/models_0";
 export { BraketServiceException } from "./models/BraketServiceException";