BatchGetRepositoryScanningConfigurationCommand

Suggest an Edit

Gets the scanning configuration for one or more repositories.

Example Syntax

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

import { ECRClient, BatchGetRepositoryScanningConfigurationCommand } from "@aws-sdk/client-ecr"; // ES Modules import
// const { ECRClient, BatchGetRepositoryScanningConfigurationCommand } = require("@aws-sdk/client-ecr"); // CommonJS import
const client = new ECRClient(config);
const input = { // BatchGetRepositoryScanningConfigurationRequest
  repositoryNames: [ // ScanningConfigurationRepositoryNameList // required
    "STRING_VALUE",
  ],
};
const command = new BatchGetRepositoryScanningConfigurationCommand(input);
const response = await client.send(command);
// { // BatchGetRepositoryScanningConfigurationResponse
//   scanningConfigurations: [ // RepositoryScanningConfigurationList
//     { // RepositoryScanningConfiguration
//       repositoryArn: "STRING_VALUE",
//       repositoryName: "STRING_VALUE",
//       scanOnPush: true || false,
//       scanFrequency: "SCAN_ON_PUSH" || "CONTINUOUS_SCAN" || "MANUAL",
//       appliedScanFilters: [ // ScanningRepositoryFilterList
//         { // ScanningRepositoryFilter
//           filter: "STRING_VALUE", // required
//           filterType: "WILDCARD", // required
//         },
//       ],
//     },
//   ],
//   failures: [ // RepositoryScanningConfigurationFailureList
//     { // RepositoryScanningConfigurationFailure
//       repositoryName: "STRING_VALUE",
//       failureCode: "REPOSITORY_NOT_FOUND",
//       failureReason: "STRING_VALUE",
//     },
//   ],
// };

BatchGetRepositoryScanningConfigurationCommand Input

See BatchGetRepositoryScanningConfigurationCommandInput for more details

Parameter
Type
Description
repositoryNames
Required
string[] | undefined

One or more repository names to get the scanning configuration for.

BatchGetRepositoryScanningConfigurationCommand Output

See BatchGetRepositoryScanningConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
failures
RepositoryScanningConfigurationFailure[] | undefined

Any failures associated with the call.

scanningConfigurations
RepositoryScanningConfiguration[] | undefined

The scanning configuration for the requested repositories.

Throws

Name
Fault
Details
InvalidParameterException
client

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

RepositoryNotFoundException
client

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.

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.