Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateCodeSecurityScanConfiguration

Creates a scan configuration for code security scanning.

Request Syntax


POST /codesecurity/scan-configuration/create HTTP/1.1
Content-type: application/json

{
   "configuration": { 
      "continuousIntegrationScanConfiguration": { 
         "supportedEvents": [ "string" ]
      },
      "periodicScanConfiguration": { 
         "frequency": "string",
         "frequencyExpression": "string"
      },
      "ruleSetCategories": [ "string" ]
   },
   "level": "string",
   "name": "string",
   "scopeSettings": { 
      "projectSelectionScope": "string"
   },
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

configuration

The configuration settings for the code security scan.

Type: CodeSecurityScanConfiguration object

Required: Yes

level

The security level for the scan configuration.

Type: String

Valid Values: ORGANIZATION | ACCOUNT

Required: Yes

name

The name of the scan configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 60.

Pattern: [a-zA-Z0-9-_$:.]*

Required: Yes

scopeSettings

The scope settings that define which repositories will be scanned. Include this parameter to create a default scan configuration. Otherwise Amazon Inspector creates a general scan configuration.

A default scan configuration automatically applies to all existing and future projects imported into Amazon Inspector. Use the BatchAssociateCodeSecurityScanConfiguration operation to associate a general scan configuration with projects.

Type: ScopeSettings object

Required: No

tags

The tags to apply to the scan configuration.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "scanConfigurationArn": "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.

scanConfigurationArn

The Amazon Resource Name (ARN) of the created scan configuration.

Type: String

Pattern: arn:(aws[a-zA-Z-]*)?:inspector2:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:owner/(\d{12}|o-[a-z0-9]{10,32})/codesecurity-configuration/[a-f0-9-]{36}

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported AWS Region.

HTTP Status Code: 403

ConflictException

A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.

HTTP Status Code: 409

InternalServerException

The request has failed due to an internal failure of the Amazon Inspector service.

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 500

ServiceQuotaExceededException

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

resourceId: The ID of the resource that exceeds a service quota.

HTTP Status Code: 402

ThrottlingException

The limit on the number of requests per second was exceeded.

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 429

ValidationException

The request has failed validation due to missing required fields or having invalid inputs.

fields: The fields that failed validation.
reason: The reason for the validation failure.

HTTP Status Code: 400