@aws-sdk/client-codeguru-security 3.352.0

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

@@ -0,0 +1,108 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { CodeGuruSecurityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeGuruSecurityClient";
+import { CreateScanRequest, CreateScanResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreateScanCommand}.
+ */
+export interface CreateScanCommandInput extends CreateScanRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateScanCommand}.
+ */
+export interface CreateScanCommandOutput extends CreateScanResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Use to create a scan using code uploaded to an S3 bucket.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CodeGuruSecurityClient, CreateScanCommand } from "@aws-sdk/client-codeguru-security"; // ES Modules import
+ * // const { CodeGuruSecurityClient, CreateScanCommand } = require("@aws-sdk/client-codeguru-security"); // CommonJS import
+ * const client = new CodeGuruSecurityClient(config);
+ * const input = { // CreateScanRequest
+ *   clientToken: "STRING_VALUE",
+ *   resourceId: { // ResourceId Union: only one key present
+ *     codeArtifactId: "STRING_VALUE",
+ *   },
+ *   scanName: "STRING_VALUE", // required
+ *   scanType: "Standard" || "Express",
+ *   analysisType: "Security" || "All",
+ *   tags: { // TagMap
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ * };
+ * const command = new CreateScanCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateScanResponse
+ * //   scanName: "STRING_VALUE", // required
+ * //   runId: "STRING_VALUE", // required
+ * //   resourceId: { // ResourceId Union: only one key present
+ * //     codeArtifactId: "STRING_VALUE",
+ * //   },
+ * //   scanState: "InProgress" || "Successful" || "Failed", // required
+ * //   scanNameArn: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param CreateScanCommandInput - {@link CreateScanCommandInput}
+ * @returns {@link CreateScanCommandOutput}
+ * @see {@link CreateScanCommandInput} for command's `input` shape.
+ * @see {@link CreateScanCommandOutput} for command's `response` shape.
+ * @see {@link CodeGuruSecurityClientResolvedConfig | config} for CodeGuruSecurityClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The requested operation would cause a conflict with the current state of a service
+ *       resource associated with the request. Resolve the conflict before retrying this
+ *       request.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The server encountered an internal error and is unable to complete the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource specified in the request was not found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the specified constraints.</p>
+ *
+ * @throws {@link CodeGuruSecurityServiceException}
+ * <p>Base exception class for all service exceptions from CodeGuruSecurity service.</p>
+ *
+ */
+export declare class CreateScanCommand extends $Command<CreateScanCommandInput, CreateScanCommandOutput, CodeGuruSecurityClientResolvedConfig> {
+    readonly input: CreateScanCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: CreateScanCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeGuruSecurityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateScanCommandInput, CreateScanCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,91 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { CodeGuruSecurityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeGuruSecurityClient";
+import { CreateUploadUrlRequest, CreateUploadUrlResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreateUploadUrlCommand}.
+ */
+export interface CreateUploadUrlCommandInput extends CreateUploadUrlRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateUploadUrlCommand}.
+ */
+export interface CreateUploadUrlCommandOutput extends CreateUploadUrlResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Generates a pre-signed URL and request headers used to upload a code resource.</p>
+ *          <p>You can upload your code resource to the URL and add the request headers using any HTTP
+ *       client.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CodeGuruSecurityClient, CreateUploadUrlCommand } from "@aws-sdk/client-codeguru-security"; // ES Modules import
+ * // const { CodeGuruSecurityClient, CreateUploadUrlCommand } = require("@aws-sdk/client-codeguru-security"); // CommonJS import
+ * const client = new CodeGuruSecurityClient(config);
+ * const input = { // CreateUploadUrlRequest
+ *   scanName: "STRING_VALUE", // required
+ * };
+ * const command = new CreateUploadUrlCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateUploadUrlResponse
+ * //   s3Url: "STRING_VALUE", // required
+ * //   requestHeaders: { // RequestHeaderMap // required
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * //   codeArtifactId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param CreateUploadUrlCommandInput - {@link CreateUploadUrlCommandInput}
+ * @returns {@link CreateUploadUrlCommandOutput}
+ * @see {@link CreateUploadUrlCommandInput} for command's `input` shape.
+ * @see {@link CreateUploadUrlCommandOutput} for command's `response` shape.
+ * @see {@link CodeGuruSecurityClientResolvedConfig | config} for CodeGuruSecurityClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The server encountered an internal error and is unable to complete the request.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the specified constraints.</p>
+ *
+ * @throws {@link CodeGuruSecurityServiceException}
+ * <p>Base exception class for all service exceptions from CodeGuruSecurity service.</p>
+ *
+ */
+export declare class CreateUploadUrlCommand extends $Command<CreateUploadUrlCommandInput, CreateUploadUrlCommandOutput, CodeGuruSecurityClientResolvedConfig> {
+    readonly input: CreateUploadUrlCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: CreateUploadUrlCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeGuruSecurityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateUploadUrlCommandInput, CreateUploadUrlCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,85 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { CodeGuruSecurityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeGuruSecurityClient";
+import { GetAccountConfigurationRequest, GetAccountConfigurationResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetAccountConfigurationCommand}.
+ */
+export interface GetAccountConfigurationCommandInput extends GetAccountConfigurationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetAccountConfigurationCommand}.
+ */
+export interface GetAccountConfigurationCommandOutput extends GetAccountConfigurationResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Use to get account level configuration.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CodeGuruSecurityClient, GetAccountConfigurationCommand } from "@aws-sdk/client-codeguru-security"; // ES Modules import
+ * // const { CodeGuruSecurityClient, GetAccountConfigurationCommand } = require("@aws-sdk/client-codeguru-security"); // CommonJS import
+ * const client = new CodeGuruSecurityClient(config);
+ * const input = {};
+ * const command = new GetAccountConfigurationCommand(input);
+ * const response = await client.send(command);
+ * // { // GetAccountConfigurationResponse
+ * //   encryptionConfig: { // EncryptionConfig
+ * //     kmsKeyArn: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetAccountConfigurationCommandInput - {@link GetAccountConfigurationCommandInput}
+ * @returns {@link GetAccountConfigurationCommandOutput}
+ * @see {@link GetAccountConfigurationCommandInput} for command's `input` shape.
+ * @see {@link GetAccountConfigurationCommandOutput} for command's `response` shape.
+ * @see {@link CodeGuruSecurityClientResolvedConfig | config} for CodeGuruSecurityClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The server encountered an internal error and is unable to complete the request.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the specified constraints.</p>
+ *
+ * @throws {@link CodeGuruSecurityServiceException}
+ * <p>Base exception class for all service exceptions from CodeGuruSecurity service.</p>
+ *
+ */
+export declare class GetAccountConfigurationCommand extends $Command<GetAccountConfigurationCommandInput, GetAccountConfigurationCommandOutput, CodeGuruSecurityClientResolvedConfig> {
+    readonly input: GetAccountConfigurationCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GetAccountConfigurationCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeGuruSecurityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAccountConfigurationCommandInput, GetAccountConfigurationCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,153 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { CodeGuruSecurityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeGuruSecurityClient";
+import { GetFindingsRequest, GetFindingsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetFindingsCommand}.
+ */
+export interface GetFindingsCommandInput extends GetFindingsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetFindingsCommand}.
+ */
+export interface GetFindingsCommandOutput extends GetFindingsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Returns a list of all findings generated by a particular scan.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CodeGuruSecurityClient, GetFindingsCommand } from "@aws-sdk/client-codeguru-security"; // ES Modules import
+ * // const { CodeGuruSecurityClient, GetFindingsCommand } = require("@aws-sdk/client-codeguru-security"); // CommonJS import
+ * const client = new CodeGuruSecurityClient(config);
+ * const input = { // GetFindingsRequest
+ *   scanName: "STRING_VALUE", // required
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ *   status: "Closed" || "Open" || "All",
+ * };
+ * const command = new GetFindingsCommand(input);
+ * const response = await client.send(command);
+ * // { // GetFindingsResponse
+ * //   findings: [ // Findings
+ * //     { // Finding
+ * //       createdAt: new Date("TIMESTAMP"),
+ * //       description: "STRING_VALUE",
+ * //       generatorId: "STRING_VALUE",
+ * //       id: "STRING_VALUE",
+ * //       updatedAt: new Date("TIMESTAMP"),
+ * //       type: "STRING_VALUE",
+ * //       status: "Closed" || "Open" || "All",
+ * //       resource: { // Resource
+ * //         id: "STRING_VALUE",
+ * //         subResourceId: "STRING_VALUE",
+ * //       },
+ * //       vulnerability: { // Vulnerability
+ * //         referenceUrls: [ // ReferenceUrls
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         relatedVulnerabilities: [ // RelatedVulnerabilities
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         id: "STRING_VALUE",
+ * //         filePath: { // FilePath
+ * //           name: "STRING_VALUE",
+ * //           path: "STRING_VALUE",
+ * //           startLine: Number("int"),
+ * //           endLine: Number("int"),
+ * //           codeSnippet: [ // CodeSnippet
+ * //             { // CodeLine
+ * //               number: Number("int"),
+ * //               content: "STRING_VALUE",
+ * //             },
+ * //           ],
+ * //         },
+ * //         itemCount: Number("int"),
+ * //       },
+ * //       severity: "Critical" || "High" || "Medium" || "Low" || "Info",
+ * //       remediation: { // Remediation
+ * //         recommendation: { // Recommendation
+ * //           text: "STRING_VALUE",
+ * //           url: "STRING_VALUE",
+ * //         },
+ * //         suggestedFixes: [ // SuggestedFixes
+ * //           { // SuggestedFix
+ * //             description: "STRING_VALUE",
+ * //             code: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //       },
+ * //       title: "STRING_VALUE",
+ * //       detectorTags: [ // DetectorTags
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       detectorId: "STRING_VALUE",
+ * //       detectorName: "STRING_VALUE",
+ * //       ruleId: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param GetFindingsCommandInput - {@link GetFindingsCommandInput}
+ * @returns {@link GetFindingsCommandOutput}
+ * @see {@link GetFindingsCommandInput} for command's `input` shape.
+ * @see {@link GetFindingsCommandOutput} for command's `response` shape.
+ * @see {@link CodeGuruSecurityClientResolvedConfig | config} for CodeGuruSecurityClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The requested operation would cause a conflict with the current state of a service
+ *       resource associated with the request. Resolve the conflict before retrying this
+ *       request.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The server encountered an internal error and is unable to complete the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource specified in the request was not found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the specified constraints.</p>
+ *
+ * @throws {@link CodeGuruSecurityServiceException}
+ * <p>Base exception class for all service exceptions from CodeGuruSecurity service.</p>
+ *
+ */
+export declare class GetFindingsCommand extends $Command<GetFindingsCommandInput, GetFindingsCommandOutput, CodeGuruSecurityClientResolvedConfig> {
+    readonly input: GetFindingsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GetFindingsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeGuruSecurityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetFindingsCommandInput, GetFindingsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,114 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { CodeGuruSecurityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeGuruSecurityClient";
+import { GetMetricsSummaryRequest, GetMetricsSummaryResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetMetricsSummaryCommand}.
+ */
+export interface GetMetricsSummaryCommandInput extends GetMetricsSummaryRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetMetricsSummaryCommand}.
+ */
+export interface GetMetricsSummaryCommandOutput extends GetMetricsSummaryResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Returns top level metrics about an account from a specified date, including number of open
+ *       findings, the categories with most findings, the scans with most open findings, and scans with
+ *       most open critical findings. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CodeGuruSecurityClient, GetMetricsSummaryCommand } from "@aws-sdk/client-codeguru-security"; // ES Modules import
+ * // const { CodeGuruSecurityClient, GetMetricsSummaryCommand } = require("@aws-sdk/client-codeguru-security"); // CommonJS import
+ * const client = new CodeGuruSecurityClient(config);
+ * const input = { // GetMetricsSummaryRequest
+ *   date: new Date("TIMESTAMP"), // required
+ * };
+ * const command = new GetMetricsSummaryCommand(input);
+ * const response = await client.send(command);
+ * // { // GetMetricsSummaryResponse
+ * //   metricsSummary: { // MetricsSummary
+ * //     date: new Date("TIMESTAMP"),
+ * //     openFindings: { // FindingMetricsValuePerSeverity
+ * //       info: Number("double"),
+ * //       low: Number("double"),
+ * //       medium: Number("double"),
+ * //       high: Number("double"),
+ * //       critical: Number("double"),
+ * //     },
+ * //     categoriesWithMostFindings: [ // CategoriesWithMostFindings
+ * //       { // CategoryWithFindingNum
+ * //         categoryName: "STRING_VALUE",
+ * //         findingNumber: Number("int"),
+ * //       },
+ * //     ],
+ * //     scansWithMostOpenFindings: [ // ScansWithMostOpenFindings
+ * //       { // ScanNameWithFindingNum
+ * //         scanName: "STRING_VALUE",
+ * //         findingNumber: Number("int"),
+ * //       },
+ * //     ],
+ * //     scansWithMostOpenCriticalFindings: [ // ScansWithMostOpenCriticalFindings
+ * //       {
+ * //         scanName: "STRING_VALUE",
+ * //         findingNumber: Number("int"),
+ * //       },
+ * //     ],
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetMetricsSummaryCommandInput - {@link GetMetricsSummaryCommandInput}
+ * @returns {@link GetMetricsSummaryCommandOutput}
+ * @see {@link GetMetricsSummaryCommandInput} for command's `input` shape.
+ * @see {@link GetMetricsSummaryCommandOutput} for command's `response` shape.
+ * @see {@link CodeGuruSecurityClientResolvedConfig | config} for CodeGuruSecurityClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The server encountered an internal error and is unable to complete the request.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the specified constraints.</p>
+ *
+ * @throws {@link CodeGuruSecurityServiceException}
+ * <p>Base exception class for all service exceptions from CodeGuruSecurity service.</p>
+ *
+ */
+export declare class GetMetricsSummaryCommand extends $Command<GetMetricsSummaryCommandInput, GetMetricsSummaryCommandOutput, CodeGuruSecurityClientResolvedConfig> {
+    readonly input: GetMetricsSummaryCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GetMetricsSummaryCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeGuruSecurityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetMetricsSummaryCommandInput, GetMetricsSummaryCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,93 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { CodeGuruSecurityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodeGuruSecurityClient";
+import { GetScanRequest, GetScanResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetScanCommand}.
+ */
+export interface GetScanCommandInput extends GetScanRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetScanCommand}.
+ */
+export interface GetScanCommandOutput extends GetScanResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Returns details about a scan, including whether or not a scan has completed.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CodeGuruSecurityClient, GetScanCommand } from "@aws-sdk/client-codeguru-security"; // ES Modules import
+ * // const { CodeGuruSecurityClient, GetScanCommand } = require("@aws-sdk/client-codeguru-security"); // CommonJS import
+ * const client = new CodeGuruSecurityClient(config);
+ * const input = { // GetScanRequest
+ *   scanName: "STRING_VALUE", // required
+ *   runId: "STRING_VALUE",
+ * };
+ * const command = new GetScanCommand(input);
+ * const response = await client.send(command);
+ * // { // GetScanResponse
+ * //   scanName: "STRING_VALUE", // required
+ * //   runId: "STRING_VALUE", // required
+ * //   scanState: "InProgress" || "Successful" || "Failed", // required
+ * //   createdAt: new Date("TIMESTAMP"), // required
+ * //   analysisType: "Security" || "All", // required
+ * //   updatedAt: new Date("TIMESTAMP"),
+ * //   numberOfRevisions: Number("long"),
+ * //   scanNameArn: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param GetScanCommandInput - {@link GetScanCommandInput}
+ * @returns {@link GetScanCommandOutput}
+ * @see {@link GetScanCommandInput} for command's `input` shape.
+ * @see {@link GetScanCommandOutput} for command's `response` shape.
+ * @see {@link CodeGuruSecurityClientResolvedConfig | config} for CodeGuruSecurityClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The server encountered an internal error and is unable to complete the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource specified in the request was not found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link CodeGuruSecurityServiceException}
+ * <p>Base exception class for all service exceptions from CodeGuruSecurity service.</p>
+ *
+ */
+export declare class GetScanCommand extends $Command<GetScanCommandInput, GetScanCommandOutput, CodeGuruSecurityClientResolvedConfig> {
+    readonly input: GetScanCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GetScanCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodeGuruSecurityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetScanCommandInput, GetScanCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}