GetRegistryScanningConfigurationCommand

Suggest an Edit

Retrieves the scanning configuration for a registry.

Example Syntax

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

import { ECRClient, GetRegistryScanningConfigurationCommand } from "@aws-sdk/client-ecr"; // ES Modules import
// const { ECRClient, GetRegistryScanningConfigurationCommand } = require("@aws-sdk/client-ecr"); // CommonJS import
const client = new ECRClient(config);
const input = {};
const command = new GetRegistryScanningConfigurationCommand(input);
const response = await client.send(command);
// { // GetRegistryScanningConfigurationResponse
//   registryId: "STRING_VALUE",
//   scanningConfiguration: { // RegistryScanningConfiguration
//     scanType: "BASIC" || "ENHANCED",
//     rules: [ // RegistryScanningRuleList
//       { // RegistryScanningRule
//         scanFrequency: "SCAN_ON_PUSH" || "CONTINUOUS_SCAN" || "MANUAL", // required
//         repositoryFilters: [ // ScanningRepositoryFilterList // required
//           { // ScanningRepositoryFilter
//             filter: "STRING_VALUE", // required
//             filterType: "WILDCARD", // required
//           },
//         ],
//       },
//     ],
//   },
// };

GetRegistryScanningConfigurationCommand Input

See GetRegistryScanningConfigurationCommandInput for more details
GetRegistryScanningConfigurationCommandInput extends GetRegistryScanningConfigurationRequest

GetRegistryScanningConfigurationCommand Output

See GetRegistryScanningConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
registryId
string | undefined

The registry ID associated with the request.

scanningConfiguration
RegistryScanningConfiguration | undefined

The scanning configuration for the registry.

Throws

Name
Fault
Details
InvalidParameterException
client

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

ServerException
server

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

ValidationException
client

There was an exception validating this request.

ECRServiceException
Base exception class for all service exceptions from ECR service.