Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

PutRegistryScanningConfiguration

Creates or updates the scanning configuration for your private registry.

Request Syntax


{
   "rules": [ 
      { 
         "repositoryFilters": [ 
            { 
               "filter": "string",
               "filterType": "string"
            }
         ],
         "scanFrequency": "string"
      }
   ],
   "scanType": "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.

rules

The scanning rules to use for the registry. A scanning rule is used to determine which repository filters are used and at what frequency scanning will occur.

Type: Array of RegistryScanningRule objects

Array Members: Minimum number of 0 items. Maximum number of 2 items.

Required: No

scanType

The scanning type to set for the registry.

When a registry scanning configuration is not defined, by default the BASIC scan type is used. When basic scanning is used, you may specify filters to determine which individual repositories, or all repositories, are scanned when new images are pushed to those repositories. Alternatively, you can do manual scans of images with basic scanning.

When the ENHANCED scan type is set, Amazon Inspector provides automated vulnerability scanning. You may choose between continuous scanning or scan on push and you may specify filters to determine which individual repositories, or all repositories, are scanned.

Type: String

Valid Values: BASIC | ENHANCED

Required: No

Response Syntax


{
   "registryScanningConfiguration": { 
      "rules": [ 
         { 
            "repositoryFilters": [ 
               { 
                  "filter": "string",
                  "filterType": "string"
               }
            ],
            "scanFrequency": "string"
         }
      ],
      "scanType": "string"
   }
}

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.

registryScanningConfiguration

The scanning configuration for your registry.

Type: RegistryScanningConfiguration object

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

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