Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

BatchGetRepositoryScanningConfiguration

Gets the scanning configuration for one or more repositories.

Request Syntax


{
   "repositoryNames": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

repositoryNames

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Length Constraints: Minimum length of 2. Maximum length of 256.

Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*

Required: Yes

Response Syntax


{
   "failures": [ 
      { 
         "failureCode": "string",
         "failureReason": "string",
         "repositoryName": "string"
      }
   ],
   "scanningConfigurations": [ 
      { 
         "appliedScanFilters": [ 
            { 
               "filter": "string",
               "filterType": "string"
            }
         ],
         "repositoryArn": "string",
         "repositoryName": "string",
         "scanFrequency": "string",
         "scanOnPush": boolean
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

failures

Any failures associated with the call.

Type: Array of RepositoryScanningConfigurationFailure objects

scanningConfigurations

The scanning configuration for the requested repositories.

Type: Array of RepositoryScanningConfiguration objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterException

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

HTTP Status Code: 400

RepositoryNotFoundException

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.

HTTP Status Code: 400

ServerException

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

HTTP Status Code: 500

ValidationException

There was an exception validating this request.

HTTP Status Code: 400