@aws-sdk/client-braket 3.296.0 → 3.298.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BraketClient";
 import { GetJobRequest, GetJobResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link GetJobCommand}.
  */
 export interface GetJobCommandInput extends GetJobRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetJobCommand}.
  */
 export interface GetJobCommandOutput extends GetJobResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Retrieves the specified Amazon Braket job.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetJobCommandOutput extends GetJobResponse, __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param GetJobCommandInput - {@link GetJobCommandInput}
+ * @returns {@link GetJobCommandOutput}
  * @see {@link GetJobCommandInput} for command's `input` shape.
  * @see {@link GetJobCommandOutput} for command's `response` shape.
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
@@ -50,11 +57,20 @@ export interface GetJobCommandOutput extends GetJobResponse, __MetadataBearer {
 export declare class GetJobCommand extends $Command<GetJobCommandInput, GetJobCommandOutput, BraketClientResolvedConfig> {
     readonly input: GetJobCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetJobCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BraketClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetJobCommandInput, GetJobCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BraketClient";
 import { GetQuantumTaskRequest, GetQuantumTaskResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link GetQuantumTaskCommand}.
  */
 export interface GetQuantumTaskCommandInput extends GetQuantumTaskRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetQuantumTaskCommand}.
  */
 export interface GetQuantumTaskCommandOutput extends GetQuantumTaskResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Retrieves the specified quantum task.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetQuantumTaskCommandOutput extends GetQuantumTaskResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param GetQuantumTaskCommandInput - {@link GetQuantumTaskCommandInput}
+ * @returns {@link GetQuantumTaskCommandOutput}
  * @see {@link GetQuantumTaskCommandInput} for command's `input` shape.
  * @see {@link GetQuantumTaskCommandOutput} for command's `response` shape.
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
@@ -50,11 +57,20 @@ export interface GetQuantumTaskCommandOutput extends GetQuantumTaskResponse, __M
 export declare class GetQuantumTaskCommand extends $Command<GetQuantumTaskCommandInput, GetQuantumTaskCommandOutput, BraketClientResolvedConfig> {
     readonly input: GetQuantumTaskCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetQuantumTaskCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BraketClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetQuantumTaskCommandInput, GetQuantumTaskCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BraketClient";
 import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Shows the tags associated with this resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * const response = await client.send(command);
  * ```
  *
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
+ * @returns {@link ListTagsForResourceCommandOutput}
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
@@ -44,11 +51,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, BraketClientResolvedConfig> {
     readonly input: ListTagsForResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListTagsForResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BraketClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BraketClient";
 import { SearchDevicesRequest, SearchDevicesResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SearchDevicesCommand}.
  */
 export interface SearchDevicesCommandInput extends SearchDevicesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SearchDevicesCommand}.
  */
 export interface SearchDevicesCommandOutput extends SearchDevicesResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Searches for devices using the specified filters.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface SearchDevicesCommandOutput extends SearchDevicesResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param SearchDevicesCommandInput - {@link SearchDevicesCommandInput}
+ * @returns {@link SearchDevicesCommandOutput}
  * @see {@link SearchDevicesCommandInput} for command's `input` shape.
  * @see {@link SearchDevicesCommandOutput} for command's `response` shape.
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
@@ -47,11 +54,20 @@ export interface SearchDevicesCommandOutput extends SearchDevicesResponse, __Met
 export declare class SearchDevicesCommand extends $Command<SearchDevicesCommandInput, SearchDevicesCommandOutput, BraketClientResolvedConfig> {
     readonly input: SearchDevicesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SearchDevicesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BraketClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchDevicesCommandInput, SearchDevicesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BraketClient";
 import { SearchJobsRequest, SearchJobsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SearchJobsCommand}.
  */
 export interface SearchJobsCommandInput extends SearchJobsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SearchJobsCommand}.
  */
 export interface SearchJobsCommandOutput extends SearchJobsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Searches for Amazon Braket jobs that match the specified filter values.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface SearchJobsCommandOutput extends SearchJobsResponse, __MetadataB
  * const response = await client.send(command);
  * ```
  *
+ * @param SearchJobsCommandInput - {@link SearchJobsCommandInput}
+ * @returns {@link SearchJobsCommandOutput}
  * @see {@link SearchJobsCommandInput} for command's `input` shape.
  * @see {@link SearchJobsCommandOutput} for command's `response` shape.
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
@@ -47,11 +54,20 @@ export interface SearchJobsCommandOutput extends SearchJobsResponse, __MetadataB
 export declare class SearchJobsCommand extends $Command<SearchJobsCommandInput, SearchJobsCommandOutput, BraketClientResolvedConfig> {
     readonly input: SearchJobsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SearchJobsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BraketClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchJobsCommandInput, SearchJobsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BraketClient";
 import { SearchQuantumTasksRequest, SearchQuantumTasksResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SearchQuantumTasksCommand}.
  */
 export interface SearchQuantumTasksCommandInput extends SearchQuantumTasksRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SearchQuantumTasksCommand}.
  */
 export interface SearchQuantumTasksCommandOutput extends SearchQuantumTasksResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Searches for tasks that match the specified filter values.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface SearchQuantumTasksCommandOutput extends SearchQuantumTasksRespo
  * const response = await client.send(command);
  * ```
  *
+ * @param SearchQuantumTasksCommandInput - {@link SearchQuantumTasksCommandInput}
+ * @returns {@link SearchQuantumTasksCommandOutput}
  * @see {@link SearchQuantumTasksCommandInput} for command's `input` shape.
  * @see {@link SearchQuantumTasksCommandOutput} for command's `response` shape.
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
@@ -47,11 +54,20 @@ export interface SearchQuantumTasksCommandOutput extends SearchQuantumTasksRespo
 export declare class SearchQuantumTasksCommand extends $Command<SearchQuantumTasksCommandInput, SearchQuantumTasksCommandOutput, BraketClientResolvedConfig> {
     readonly input: SearchQuantumTasksCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SearchQuantumTasksCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BraketClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchQuantumTasksCommandInput, SearchQuantumTasksCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BraketClient";
 import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Add a tag to the specified resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
@@ -44,11 +51,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, BraketClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BraketClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BraketClient";
 import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Remove tags from a resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
@@ -44,11 +51,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, BraketClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BraketClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/BraketServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from Braket service.
  */
 export declare class BraketServiceException extends __ServiceException {