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

GetCodeSecurityScanConfiguration

Retrieves information about a code security scan configuration.

Request Syntax


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

{
   "scanConfigurationArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

scanConfigurationArn

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

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}

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "configuration": { 
      "continuousIntegrationScanConfiguration": { 
         "supportedEvents": [ "string" ]
      },
      "periodicScanConfiguration": { 
         "frequency": "string",
         "frequencyExpression": "string"
      },
      "ruleSetCategories": [ "string" ]
   },
   "createdAt": number,
   "lastUpdatedAt": number,
   "level": "string",
   "name": "string",
   "scanConfigurationArn": "string",
   "scopeSettings": { 
      "projectSelectionScope": "string"
   },
   "tags": { 
      "string" : "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.

configuration

The configuration settings for the code security scan.

Type: CodeSecurityScanConfiguration object

createdAt

The timestamp when the scan configuration was created.

Type: Timestamp

lastUpdatedAt

The timestamp when the scan configuration was last updated.

Type: Timestamp

level

The security level for the scan configuration.

Type: String

Valid Values: ORGANIZATION | ACCOUNT

name

The name of the scan configuration.

Type: String

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

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

scanConfigurationArn

The Amazon Resource Name (ARN) of the 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}

scopeSettings

The scope settings that define which repositories will be scanned. If the ScopeSetting parameter is ALL the scan configuration applies to all existing and future projects imported into Amazon Inspector.

Type: ScopeSettings object

tags

The tags associated with 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.

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 Amazon Web Services Region.

HTTP Status Code: 403

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400