import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ECRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRClient"; import type { StartImageScanRequest, StartImageScanResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link StartImageScanCommand}. */ export interface StartImageScanCommandInput extends StartImageScanRequest { } /** * @public * * The output of {@link StartImageScanCommand}. */ export interface StartImageScanCommandOutput extends StartImageScanResponse, __MetadataBearer { } declare const StartImageScanCommand_base: { new (input: StartImageScanCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: StartImageScanCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Starts a basic image vulnerability scan.

*

A basic image scan can only be started once per 24 hours on an individual image. This * limit includes if an image was scanned on initial push. You can start up to 100,000 * basic scans per 24 hours. This limit includes both scans on initial push and scans * initiated by the StartImageScan API. For more information, see Basic scanning in the Amazon Elastic Container Registry User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ECRClient, StartImageScanCommand } from "@aws-sdk/client-ecr"; // ES Modules import * // const { ECRClient, StartImageScanCommand } = require("@aws-sdk/client-ecr"); // CommonJS import * // import type { ECRClientConfig } from "@aws-sdk/client-ecr"; * const config = {}; // type is ECRClientConfig * const client = new ECRClient(config); * const input = { // StartImageScanRequest * registryId: "STRING_VALUE", * repositoryName: "STRING_VALUE", // required * imageId: { // ImageIdentifier * imageDigest: "STRING_VALUE", * imageTag: "STRING_VALUE", * }, * }; * const command = new StartImageScanCommand(input); * const response = await client.send(command); * // { // StartImageScanResponse * // registryId: "STRING_VALUE", * // repositoryName: "STRING_VALUE", * // imageId: { // ImageIdentifier * // imageDigest: "STRING_VALUE", * // imageTag: "STRING_VALUE", * // }, * // imageScanStatus: { // ImageScanStatus * // status: "IN_PROGRESS" || "COMPLETE" || "FAILED" || "UNSUPPORTED_IMAGE" || "ACTIVE" || "PENDING" || "SCAN_ELIGIBILITY_EXPIRED" || "FINDINGS_UNAVAILABLE" || "LIMIT_EXCEEDED" || "IMAGE_ARCHIVED", * // description: "STRING_VALUE", * // }, * // }; * * ``` * * @param StartImageScanCommandInput - {@link StartImageScanCommandInput} * @returns {@link StartImageScanCommandOutput} * @see {@link StartImageScanCommandInput} for command's `input` shape. * @see {@link StartImageScanCommandOutput} for command's `response` shape. * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape. * * @throws {@link ImageArchivedException} (client fault) *

The specified image is archived and cannot be scanned.

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

The image requested does not exist in the specified repository.

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

The specified parameter is invalid. Review the available parameters for the API * request.

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

The operation did not succeed because it would have exceeded a service limit for your * account. For more information, see Amazon ECR service quotas in * the Amazon Elastic Container Registry User Guide.

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

The specified repository could not be found. Check the spelling of the specified * repository and ensure that you are performing operations on the correct registry.

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

These errors are usually caused by a server-side issue.

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

The image is of a type that cannot be scanned.

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

There was an exception validating this request.

* * @throws {@link ECRServiceException} *

Base exception class for all service exceptions from ECR service.

* * * @public */ export declare class StartImageScanCommand extends StartImageScanCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartImageScanRequest; output: StartImageScanResponse; }; sdk: { input: StartImageScanCommandInput; output: StartImageScanCommandOutput; }; }; }