PutImageScanningConfiguration - Amazon Elastic Container Registry

PutImageScanningConfiguration

Updates the image scanning configuration for the specified repository.

Request Syntax

{ "imageScanningConfiguration": { "scanOnPush": boolean }, "registryId": "string", "repositoryName": "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.

imageScanningConfiguration

The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository.

Type: ImageScanningConfiguration object

Required: Yes

registryId

The AWS account ID associated with the registry that contains the repository in which to update the image scanning configuration setting. If you do not specify a registry, the default registry is assumed.

Type: String

Pattern: [0-9]{12}

Required: No

repositoryName

The name of the repository in which to update the image scanning configuration setting.

Type: String

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

{ "imageScanningConfiguration": { "scanOnPush": boolean }, "registryId": "string", "repositoryName": "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.

imageScanningConfiguration

The image scanning configuration setting for the repository.

Type: ImageScanningConfiguration object

registryId

The registry ID associated with the request.

Type: String

Pattern: [0-9]{12}

repositoryName

The repository name associated with the request.

Type: String

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

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

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

Examples

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

This example updates the image scanning configuration for the sample-repo repository.

Sample Request

POST / HTTP/1.1 Host: ecr.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 90 X-Amz-Target: AmazonEC2ContainerRegistry_V20150921.PutImageScanningConfiguration X-Amz-Date: 20161216T201255Z User-Agent: aws-cli/1.16.310 Python/3.6.1 Darwin/18.7.0 botocore/1.13.46 Content-Type: application/x-amz-json-1.1 Authorization: AUTHPARAMS { "repositoryName": "sample-repo", "imageScanningConfiguration": { "scanOnPush": true } }

Sample Response

HTTP/1.1 200 OK Server: Server Date: Fri, 24 Jan 2020 03:48:07 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 114 Connection: keep-alive x-amzn-RequestId: 3081a92b-2066-41f8-8a47-0580288ada9e { "registryId": "012345678910", "repositoryName": "sample-repo", "imageScanningConfiguration": { "scanOnPush": true } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: