@aws/lsp-codewhisperer 0.0.83 → 0.0.85

package/node_modules/@amzn/codewhisperer-runtime/dist-types/commands/SendTelemetryEventCommand.d.ts

@@ -0,0 +1,403 @@
+import { CodeWhispererRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeWhispererRuntimeClient";
+import { SendTelemetryEventRequest, SendTelemetryEventResponse } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link SendTelemetryEventCommand}.
+ */
+export interface SendTelemetryEventCommandInput extends SendTelemetryEventRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link SendTelemetryEventCommand}.
+ */
+export interface SendTelemetryEventCommandOutput extends SendTelemetryEventResponse, __MetadataBearer {
+}
+declare const SendTelemetryEventCommand_base: {
+    new (input: SendTelemetryEventCommandInput): import("@smithy/smithy-client").CommandImpl<SendTelemetryEventCommandInput, SendTelemetryEventCommandOutput, CodeWhispererRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: SendTelemetryEventCommandInput): import("@smithy/smithy-client").CommandImpl<SendTelemetryEventCommandInput, SendTelemetryEventCommandOutput, CodeWhispererRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * API to record telemetry events.
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CodeWhispererRuntimeClient, SendTelemetryEventCommand } from "@amzn/codewhisperer-runtime"; // ES Modules import
+ * // const { CodeWhispererRuntimeClient, SendTelemetryEventCommand } = require("@amzn/codewhisperer-runtime"); // CommonJS import
+ * const client = new CodeWhispererRuntimeClient(config);
+ * const input = { // SendTelemetryEventRequest
+ *   clientToken: "STRING_VALUE",
+ *   telemetryEvent: { // TelemetryEvent Union: only one key present
+ *     userTriggerDecisionEvent: { // UserTriggerDecisionEvent
+ *       sessionId: "STRING_VALUE", // required
+ *       requestId: "STRING_VALUE", // required
+ *       customizationArn: "STRING_VALUE",
+ *       programmingLanguage: { // ProgrammingLanguage
+ *         languageName: "STRING_VALUE", // required
+ *       },
+ *       completionType: "STRING_VALUE", // required
+ *       suggestionState: "STRING_VALUE", // required
+ *       recommendationLatencyMilliseconds: Number("double"), // required
+ *       timestamp: new Date("TIMESTAMP"), // required
+ *       triggerToResponseLatencyMilliseconds: Number("double"),
+ *       suggestionReferenceCount: Number("int"),
+ *       generatedLine: Number("int"),
+ *       numberOfRecommendations: Number("int"),
+ *       perceivedLatencyMilliseconds: Number("double"),
+ *       acceptedCharacterCount: Number("int"),
+ *       addedIdeDiagnostics: [ // IdeDiagnosticList
+ *         { // IdeDiagnostic
+ *           range: { // Range
+ *             start: { // Position
+ *               line: Number("int"), // required
+ *               character: Number("int"), // required
+ *             },
+ *             end: {
+ *               line: Number("int"), // required
+ *               character: Number("int"), // required
+ *             },
+ *           },
+ *           source: "STRING_VALUE",
+ *           severity: "ERROR" || "WARNING" || "INFORMATION" || "HINT",
+ *           ideDiagnosticType: "SYNTAX_ERROR" || "TYPE_ERROR" || "REFERENCE_ERROR" || "BEST_PRACTICE" || "SECURITY" || "OTHER", // required
+ *         },
+ *       ],
+ *       removedIdeDiagnostics: [
+ *         {
+ *           range: {
+ *             start: {
+ *               line: Number("int"), // required
+ *               character: Number("int"), // required
+ *             },
+ *             end: {
+ *               line: Number("int"), // required
+ *               character: Number("int"), // required
+ *             },
+ *           },
+ *           source: "STRING_VALUE",
+ *           severity: "ERROR" || "WARNING" || "INFORMATION" || "HINT",
+ *           ideDiagnosticType: "SYNTAX_ERROR" || "TYPE_ERROR" || "REFERENCE_ERROR" || "BEST_PRACTICE" || "SECURITY" || "OTHER", // required
+ *         },
+ *       ],
+ *       addedCharacterCount: Number("int"),
+ *       deletedCharacterCount: Number("int"),
+ *       streakLength: Number("int"),
+ *       suggestionType: "STRING_VALUE",
+ *     },
+ *     codeCoverageEvent: { // CodeCoverageEvent
+ *       customizationArn: "STRING_VALUE",
+ *       programmingLanguage: {
+ *         languageName: "STRING_VALUE", // required
+ *       },
+ *       acceptedCharacterCount: Number("int"), // required
+ *       totalCharacterCount: Number("int"), // required
+ *       timestamp: new Date("TIMESTAMP"), // required
+ *       unmodifiedAcceptedCharacterCount: Number("int"),
+ *       totalNewCodeCharacterCount: Number("int"),
+ *       totalNewCodeLineCount: Number("int"),
+ *       userWrittenCodeCharacterCount: Number("int"),
+ *       userWrittenCodeLineCount: Number("int"),
+ *       addedCharacterCount: Number("int"),
+ *     },
+ *     userModificationEvent: { // UserModificationEvent
+ *       sessionId: "STRING_VALUE", // required
+ *       requestId: "STRING_VALUE", // required
+ *       programmingLanguage: {
+ *         languageName: "STRING_VALUE", // required
+ *       },
+ *       modificationPercentage: Number("double"), // required
+ *       customizationArn: "STRING_VALUE",
+ *       timestamp: new Date("TIMESTAMP"), // required
+ *       acceptedCharacterCount: Number("int"), // required
+ *       unmodifiedAcceptedCharacterCount: Number("int"), // required
+ *       addedCharacterCount: Number("int"),
+ *       unmodifiedAddedCharacterCount: Number("int"),
+ *     },
+ *     codeScanEvent: { // CodeScanEvent
+ *       programmingLanguage: {
+ *         languageName: "STRING_VALUE", // required
+ *       },
+ *       codeScanJobId: "STRING_VALUE", // required
+ *       timestamp: new Date("TIMESTAMP"), // required
+ *       codeAnalysisScope: "STRING_VALUE",
+ *     },
+ *     codeScanSucceededEvent: { // CodeScanSucceededEvent
+ *       programmingLanguage: {
+ *         languageName: "STRING_VALUE", // required
+ *       },
+ *       codeScanJobId: "STRING_VALUE", // required
+ *       timestamp: new Date("TIMESTAMP"), // required
+ *       numberOfFindings: Number("int"), // required
+ *       codeAnalysisScope: "STRING_VALUE",
+ *     },
+ *     codeScanFailedEvent: { // CodeScanFailedEvent
+ *       programmingLanguage: "<ProgrammingLanguage>", // required
+ *       codeScanJobId: "STRING_VALUE", // required
+ *       timestamp: new Date("TIMESTAMP"), // required
+ *       codeAnalysisScope: "STRING_VALUE",
+ *     },
+ *     codeScanRemediationsEvent: { // CodeScanRemediationsEvent
+ *       programmingLanguage: "<ProgrammingLanguage>",
+ *       CodeScanRemediationsEventType: "STRING_VALUE",
+ *       timestamp: new Date("TIMESTAMP"),
+ *       detectorId: "STRING_VALUE",
+ *       findingId: "STRING_VALUE",
+ *       ruleId: "STRING_VALUE",
+ *       component: "STRING_VALUE",
+ *       reason: "STRING_VALUE",
+ *       result: "STRING_VALUE",
+ *       includesFix: true || false,
+ *     },
+ *     codeFixGenerationEvent: { // CodeFixGenerationEvent
+ *       jobId: "STRING_VALUE", // required
+ *       ruleId: "STRING_VALUE",
+ *       detectorId: "STRING_VALUE",
+ *       findingId: "STRING_VALUE",
+ *       programmingLanguage: "<ProgrammingLanguage>",
+ *       linesOfCodeGenerated: Number("int"),
+ *       charsOfCodeGenerated: Number("int"),
+ *     },
+ *     codeFixAcceptanceEvent: { // CodeFixAcceptanceEvent
+ *       jobId: "STRING_VALUE", // required
+ *       ruleId: "STRING_VALUE",
+ *       detectorId: "STRING_VALUE",
+ *       findingId: "STRING_VALUE",
+ *       programmingLanguage: "<ProgrammingLanguage>",
+ *       linesOfCodeAccepted: Number("int"),
+ *       charsOfCodeAccepted: Number("int"),
+ *     },
+ *     metricData: { // MetricData
+ *       metricName: "STRING_VALUE", // required
+ *       metricValue: Number("double"), // required
+ *       timestamp: new Date("TIMESTAMP"), // required
+ *       product: "STRING_VALUE", // required
+ *       dimensions: [ // DimensionList
+ *         { // Dimension
+ *           name: "STRING_VALUE",
+ *           value: "STRING_VALUE",
+ *         },
+ *       ],
+ *     },
+ *     chatAddMessageEvent: { // ChatAddMessageEvent
+ *       conversationId: "STRING_VALUE", // required
+ *       messageId: "STRING_VALUE", // required
+ *       customizationArn: "STRING_VALUE",
+ *       userIntent: "SUGGEST_ALTERNATE_IMPLEMENTATION" || "APPLY_COMMON_BEST_PRACTICES" || "IMPROVE_CODE" || "SHOW_EXAMPLES" || "CITE_SOURCES" || "EXPLAIN_LINE_BY_LINE" || "EXPLAIN_CODE_SELECTION" || "GENERATE_CLOUDFORMATION_TEMPLATE" || "GENERATE_UNIT_TESTS" || "CODE_GENERATION",
+ *       hasCodeSnippet: true || false,
+ *       programmingLanguage: "<ProgrammingLanguage>",
+ *       activeEditorTotalCharacters: Number("int"),
+ *       timeToFirstChunkMilliseconds: Number("double"),
+ *       timeBetweenChunks: [ // timeBetweenChunks
+ *         Number("double"),
+ *       ],
+ *       fullResponselatency: Number("double"),
+ *       requestLength: Number("int"),
+ *       responseLength: Number("int"),
+ *       numberOfCodeBlocks: Number("int"),
+ *       hasProjectLevelContext: true || false,
+ *       result: "STRING_VALUE",
+ *     },
+ *     chatInteractWithMessageEvent: { // ChatInteractWithMessageEvent
+ *       conversationId: "STRING_VALUE", // required
+ *       messageId: "STRING_VALUE", // required
+ *       customizationArn: "STRING_VALUE",
+ *       interactionType: "STRING_VALUE",
+ *       interactionTarget: "STRING_VALUE",
+ *       acceptedCharacterCount: Number("int"),
+ *       acceptedLineCount: Number("int"),
+ *       acceptedSnippetHasReference: true || false,
+ *       hasProjectLevelContext: true || false,
+ *       userIntent: "SUGGEST_ALTERNATE_IMPLEMENTATION" || "APPLY_COMMON_BEST_PRACTICES" || "IMPROVE_CODE" || "SHOW_EXAMPLES" || "CITE_SOURCES" || "EXPLAIN_LINE_BY_LINE" || "EXPLAIN_CODE_SELECTION" || "GENERATE_CLOUDFORMATION_TEMPLATE" || "GENERATE_UNIT_TESTS" || "CODE_GENERATION",
+ *       addedIdeDiagnostics: [
+ *         {
+ *           range: {
+ *             start: {
+ *               line: Number("int"), // required
+ *               character: Number("int"), // required
+ *             },
+ *             end: "<Position>", // required
+ *           },
+ *           source: "STRING_VALUE",
+ *           severity: "ERROR" || "WARNING" || "INFORMATION" || "HINT",
+ *           ideDiagnosticType: "SYNTAX_ERROR" || "TYPE_ERROR" || "REFERENCE_ERROR" || "BEST_PRACTICE" || "SECURITY" || "OTHER", // required
+ *         },
+ *       ],
+ *       removedIdeDiagnostics: [
+ *         {
+ *           range: {
+ *             start: "<Position>", // required
+ *             end: "<Position>", // required
+ *           },
+ *           source: "STRING_VALUE",
+ *           severity: "ERROR" || "WARNING" || "INFORMATION" || "HINT",
+ *           ideDiagnosticType: "SYNTAX_ERROR" || "TYPE_ERROR" || "REFERENCE_ERROR" || "BEST_PRACTICE" || "SECURITY" || "OTHER", // required
+ *         },
+ *       ],
+ *     },
+ *     chatUserModificationEvent: { // ChatUserModificationEvent
+ *       conversationId: "STRING_VALUE", // required
+ *       customizationArn: "STRING_VALUE",
+ *       messageId: "STRING_VALUE", // required
+ *       programmingLanguage: "<ProgrammingLanguage>",
+ *       modificationPercentage: Number("double"), // required
+ *       hasProjectLevelContext: true || false,
+ *     },
+ *     terminalUserInteractionEvent: { // TerminalUserInteractionEvent
+ *       terminalUserInteractionEventType: "STRING_VALUE",
+ *       terminal: "STRING_VALUE",
+ *       terminalVersion: "STRING_VALUE",
+ *       shell: "STRING_VALUE",
+ *       shellVersion: "STRING_VALUE",
+ *       duration: Number("int"),
+ *       timeToSuggestion: Number("int"),
+ *       isCompletionAccepted: true || false,
+ *       cliToolCommand: "STRING_VALUE",
+ *     },
+ *     featureDevEvent: { // FeatureDevEvent
+ *       conversationId: "STRING_VALUE", // required
+ *     },
+ *     featureDevCodeGenerationEvent: { // FeatureDevCodeGenerationEvent
+ *       conversationId: "STRING_VALUE", // required
+ *       linesOfCodeGenerated: Number("int"), // required
+ *       charactersOfCodeGenerated: Number("int"), // required
+ *       programmingLanguage: "<ProgrammingLanguage>",
+ *     },
+ *     featureDevCodeAcceptanceEvent: { // FeatureDevCodeAcceptanceEvent
+ *       conversationId: "STRING_VALUE", // required
+ *       linesOfCodeAccepted: Number("int"), // required
+ *       charactersOfCodeAccepted: Number("int"), // required
+ *       programmingLanguage: "<ProgrammingLanguage>",
+ *     },
+ *     inlineChatEvent: { // InlineChatEvent
+ *       requestId: "STRING_VALUE", // required
+ *       timestamp: new Date("TIMESTAMP"), // required
+ *       inputLength: Number("int"),
+ *       numSelectedLines: Number("int"),
+ *       numSuggestionAddChars: Number("int"),
+ *       numSuggestionAddLines: Number("int"),
+ *       numSuggestionDelChars: Number("int"),
+ *       numSuggestionDelLines: Number("int"),
+ *       codeIntent: true || false,
+ *       userDecision: "STRING_VALUE",
+ *       responseStartLatency: Number("double"),
+ *       responseEndLatency: Number("double"),
+ *       programmingLanguage: "<ProgrammingLanguage>",
+ *     },
+ *     transformEvent: { // TransformEvent
+ *       jobId: "STRING_VALUE", // required
+ *       timestamp: new Date("TIMESTAMP"),
+ *       ideCategory: "STRING_VALUE",
+ *       programmingLanguage: "<ProgrammingLanguage>",
+ *       linesOfCodeChanged: Number("int"),
+ *       charsOfCodeChanged: Number("int"),
+ *       linesOfCodeSubmitted: Number("int"),
+ *     },
+ *     docGenerationEvent: { // DocGenerationEvent
+ *       conversationId: "STRING_VALUE", // required
+ *       numberOfAddChars: Number("int"),
+ *       numberOfAddLines: Number("int"),
+ *       numberOfAddFiles: Number("int"),
+ *       userDecision: "STRING_VALUE",
+ *       interactionType: "STRING_VALUE",
+ *       userIdentity: "STRING_VALUE",
+ *       numberOfNavigation: Number("int"),
+ *       folderLevel: "STRING_VALUE",
+ *     },
+ *     docV2GenerationEvent: { // DocV2GenerationEvent
+ *       conversationId: "STRING_VALUE", // required
+ *       numberOfGeneratedChars: Number("int"), // required
+ *       numberOfGeneratedLines: Number("int"), // required
+ *       numberOfGeneratedFiles: Number("int"), // required
+ *       interactionType: "STRING_VALUE",
+ *       numberOfNavigations: Number("int"),
+ *       folderLevel: "STRING_VALUE",
+ *     },
+ *     docV2AcceptanceEvent: { // DocV2AcceptanceEvent
+ *       conversationId: "STRING_VALUE", // required
+ *       numberOfAddedChars: Number("int"), // required
+ *       numberOfAddedLines: Number("int"), // required
+ *       numberOfAddedFiles: Number("int"), // required
+ *       userDecision: "STRING_VALUE", // required
+ *       interactionType: "STRING_VALUE", // required
+ *       numberOfNavigations: Number("int"), // required
+ *       folderLevel: "STRING_VALUE", // required
+ *     },
+ *     testGenerationEvent: { // TestGenerationEvent
+ *       jobId: "STRING_VALUE", // required
+ *       groupName: "STRING_VALUE", // required
+ *       timestamp: new Date("TIMESTAMP"),
+ *       ideCategory: "STRING_VALUE",
+ *       programmingLanguage: "<ProgrammingLanguage>",
+ *       numberOfUnitTestCasesGenerated: Number("int"),
+ *       numberOfUnitTestCasesAccepted: Number("int"),
+ *       linesOfCodeGenerated: Number("int"),
+ *       linesOfCodeAccepted: Number("int"),
+ *       charsOfCodeGenerated: Number("int"),
+ *       charsOfCodeAccepted: Number("int"),
+ *     },
+ *   },
+ *   optOutPreference: "STRING_VALUE",
+ *   userContext: { // UserContext
+ *     ideCategory: "STRING_VALUE", // required
+ *     operatingSystem: "STRING_VALUE", // required
+ *     product: "STRING_VALUE", // required
+ *     clientId: "STRING_VALUE",
+ *     ideVersion: "STRING_VALUE",
+ *     pluginVersion: "STRING_VALUE",
+ *     lspVersion: "STRING_VALUE",
+ *   },
+ *   profileArn: "STRING_VALUE",
+ *   modelId: "STRING_VALUE",
+ * };
+ * const command = new SendTelemetryEventCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param SendTelemetryEventCommandInput - {@link SendTelemetryEventCommandInput}
+ * @returns {@link SendTelemetryEventCommandOutput}
+ * @see {@link SendTelemetryEventCommandInput} for command's `input` shape.
+ * @see {@link SendTelemetryEventCommandOutput} for command's `response` shape.
+ * @see {@link CodeWhispererRuntimeClientResolvedConfig | config} for CodeWhispererRuntimeClient's `config` shape.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  This exception is thrown when an unexpected error occurred during the processing of a request.
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  This exception is thrown when request was denied due to request throttling.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  This exception is thrown when the input fails to satisfy the constraints specified by the service.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  This exception is thrown when the user does not have sufficient access to perform this action.
+ *
+ * @throws {@link CodeWhispererRuntimeServiceException}
+ * <p>Base exception class for all service exceptions from CodeWhispererRuntime service.</p>
+ *
+ * @public
+ */
+export declare class SendTelemetryEventCommand extends SendTelemetryEventCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: SendTelemetryEventRequest;
+            output: {};
+        };
+        sdk: {
+            input: SendTelemetryEventCommandInput;
+            output: SendTelemetryEventCommandOutput;
+        };
+    };
+}

package/node_modules/@amzn/codewhisperer-runtime/dist-types/commands/SetUserPreferenceCommand.d.ts

@@ -0,0 +1,84 @@
+import { CodeWhispererRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeWhispererRuntimeClient";
+import { SetUserPreferenceRequest, SetUserPreferenceResponse } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link SetUserPreferenceCommand}.
+ */
+export interface SetUserPreferenceCommandInput extends SetUserPreferenceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link SetUserPreferenceCommand}.
+ */
+export interface SetUserPreferenceCommandOutput extends SetUserPreferenceResponse, __MetadataBearer {
+}
+declare const SetUserPreferenceCommand_base: {
+    new (input: SetUserPreferenceCommandInput): import("@smithy/smithy-client").CommandImpl<SetUserPreferenceCommandInput, SetUserPreferenceCommandOutput, CodeWhispererRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [SetUserPreferenceCommandInput]): import("@smithy/smithy-client").CommandImpl<SetUserPreferenceCommandInput, SetUserPreferenceCommandOutput, CodeWhispererRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * API to set user preference
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CodeWhispererRuntimeClient, SetUserPreferenceCommand } from "@amzn/codewhisperer-runtime"; // ES Modules import
+ * // const { CodeWhispererRuntimeClient, SetUserPreferenceCommand } = require("@amzn/codewhisperer-runtime"); // CommonJS import
+ * const client = new CodeWhispererRuntimeClient(config);
+ * const input = { // SetUserPreferenceRequest
+ *   overageConfiguration: { // OverageConfiguration
+ *     overageStatus: "STRING_VALUE", // required
+ *   },
+ *   profileArn: "STRING_VALUE",
+ * };
+ * const command = new SetUserPreferenceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param SetUserPreferenceCommandInput - {@link SetUserPreferenceCommandInput}
+ * @returns {@link SetUserPreferenceCommandOutput}
+ * @see {@link SetUserPreferenceCommandInput} for command's `input` shape.
+ * @see {@link SetUserPreferenceCommandOutput} for command's `response` shape.
+ * @see {@link CodeWhispererRuntimeClientResolvedConfig | config} for CodeWhispererRuntimeClient's `config` shape.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  This exception is thrown when an unexpected error occurred during the processing of a request.
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  This exception is thrown when request was denied due to request throttling.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  This exception is thrown when the input fails to satisfy the constraints specified by the service.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  This exception is thrown when the user does not have sufficient access to perform this action.
+ *
+ * @throws {@link CodeWhispererRuntimeServiceException}
+ * <p>Base exception class for all service exceptions from CodeWhispererRuntime service.</p>
+ *
+ * @public
+ */
+export declare class SetUserPreferenceCommand extends SetUserPreferenceCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: SetUserPreferenceRequest;
+            output: {};
+        };
+        sdk: {
+            input: SetUserPreferenceCommandInput;
+            output: SetUserPreferenceCommandOutput;
+        };
+    };
+}

package/node_modules/@amzn/codewhisperer-runtime/dist-types/commands/StartCodeAnalysisCommand.d.ts

@@ -0,0 +1,105 @@
+import { CodeWhispererRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeWhispererRuntimeClient";
+import { StartCodeAnalysisRequest, StartCodeAnalysisResponse } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartCodeAnalysisCommand}.
+ */
+export interface StartCodeAnalysisCommandInput extends StartCodeAnalysisRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartCodeAnalysisCommand}.
+ */
+export interface StartCodeAnalysisCommandOutput extends StartCodeAnalysisResponse, __MetadataBearer {
+}
+declare const StartCodeAnalysisCommand_base: {
+    new (input: StartCodeAnalysisCommandInput): import("@smithy/smithy-client").CommandImpl<StartCodeAnalysisCommandInput, StartCodeAnalysisCommandOutput, CodeWhispererRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: StartCodeAnalysisCommandInput): import("@smithy/smithy-client").CommandImpl<StartCodeAnalysisCommandInput, StartCodeAnalysisCommandOutput, CodeWhispererRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Starts a code analysis job
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CodeWhispererRuntimeClient, StartCodeAnalysisCommand } from "@amzn/codewhisperer-runtime"; // ES Modules import
+ * // const { CodeWhispererRuntimeClient, StartCodeAnalysisCommand } = require("@amzn/codewhisperer-runtime"); // CommonJS import
+ * const client = new CodeWhispererRuntimeClient(config);
+ * const input = { // StartCodeAnalysisRequest
+ *   artifacts: { // ArtifactMap // required
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ *   programmingLanguage: { // ProgrammingLanguage
+ *     languageName: "STRING_VALUE", // required
+ *   },
+ *   clientToken: "STRING_VALUE",
+ *   scope: "STRING_VALUE",
+ *   codeScanName: "STRING_VALUE",
+ *   codeDiffMetadata: { // CodeDiffMetadata
+ *     codeDiffPath: "STRING_VALUE",
+ *   },
+ *   profileArn: "STRING_VALUE",
+ *   languageModelId: "STRING_VALUE",
+ *   clientType: "STRING_VALUE",
+ * };
+ * const command = new StartCodeAnalysisCommand(input);
+ * const response = await client.send(command);
+ * // { // StartCodeAnalysisResponse
+ * //   jobId: "STRING_VALUE", // required
+ * //   status: "STRING_VALUE", // required
+ * //   errorMessage: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param StartCodeAnalysisCommandInput - {@link StartCodeAnalysisCommandInput}
+ * @returns {@link StartCodeAnalysisCommandOutput}
+ * @see {@link StartCodeAnalysisCommandInput} for command's `input` shape.
+ * @see {@link StartCodeAnalysisCommandOutput} for command's `response` shape.
+ * @see {@link CodeWhispererRuntimeClientResolvedConfig | config} for CodeWhispererRuntimeClient's `config` shape.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  This exception is thrown when an unexpected error occurred during the processing of a request.
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  This exception is thrown when request was denied due to request throttling.
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  This exception is thrown when the action to perform could not be completed because the resource is in a conflicting state.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  This exception is thrown when the input fails to satisfy the constraints specified by the service.
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  This exception is thrown when describing a resource that does not exist.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  This exception is thrown when the user does not have sufficient access to perform this action.
+ *
+ * @throws {@link CodeWhispererRuntimeServiceException}
+ * <p>Base exception class for all service exceptions from CodeWhispererRuntime service.</p>
+ *
+ * @public
+ */
+export declare class StartCodeAnalysisCommand extends StartCodeAnalysisCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StartCodeAnalysisRequest;
+            output: StartCodeAnalysisResponse;
+        };
+        sdk: {
+            input: StartCodeAnalysisCommandInput;
+            output: StartCodeAnalysisCommandOutput;
+        };
+    };
+}