Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class PutRegistryScanningConfigurationCommandProtected

Creates or updates the scanning configuration for your private registry.

Example

Use a bare-bones client and the command you need to make an API call.

import { ECRClient, PutRegistryScanningConfigurationCommand } from "@aws-sdk/client-ecr"; // ES Modules import
// const { ECRClient, PutRegistryScanningConfigurationCommand } = require("@aws-sdk/client-ecr"); // CommonJS import
const client = new ECRClient(config);
const input = { // PutRegistryScanningConfigurationRequest
scanType: "STRING_VALUE",
rules: [ // RegistryScanningRuleList
{ // RegistryScanningRule
scanFrequency: "STRING_VALUE", // required
repositoryFilters: [ // ScanningRepositoryFilterList // required
{ // ScanningRepositoryFilter
filter: "STRING_VALUE", // required
filterType: "STRING_VALUE", // required
},
],
},
],
};
const command = new PutRegistryScanningConfigurationCommand(input);
const response = await client.send(command);
// { // PutRegistryScanningConfigurationResponse
// registryScanningConfiguration: { // RegistryScanningConfiguration
// scanType: "STRING_VALUE",
// rules: [ // RegistryScanningRuleList
// { // RegistryScanningRule
// scanFrequency: "STRING_VALUE", // required
// repositoryFilters: [ // ScanningRepositoryFilterList // required
// { // ScanningRepositoryFilter
// filter: "STRING_VALUE", // required
// filterType: "STRING_VALUE", // required
// },
// ],
// },
// ],
// },
// };

Param

PutRegistryScanningConfigurationCommandInput

Returns

PutRegistryScanningConfigurationCommandOutput

See

Throws

InvalidParameterException (client fault)

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

Throws

ServerException (server fault)

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

Throws

ValidationException (client fault)

There was an exception validating this request.

Throws

ECRServiceException

Base exception class for all service exceptions from ECR service.

Hierarchy

Constructors

Properties

Methods