AWS.CodeGuruSecurity — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Note: Amazon CodeGuru Security is in preview release and is subject to change.

This section provides documentation for the Amazon CodeGuru Security API operations. CodeGuru Security is a service that uses program analysis and machine learning to detect security policy violations and vulnerabilities, and recommends ways to address these security risks.

By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the overall security of your application code. For more information about CodeGuru Security, see the Amazon CodeGuru Security User Guide.

Sending a Request Using CodeGuruSecurity

var codegurusecurity = new AWS.CodeGuruSecurity();
codegurusecurity.batchGetFindings(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the CodeGuruSecurity object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var codegurusecurity = new AWS.CodeGuruSecurity({apiVersion: '2018-05-10'});

You can also set the API version globally in AWS.config.apiVersions using the codegurusecurity service identifier:

AWS.config.apiVersions = {
  codegurusecurity: '2018-05-10',
  // other service API versions
};

var codegurusecurity = new AWS.CodeGuruSecurity();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.CodeGuruSecurity(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

batchGetFindings(params = {}, callback) ⇒ AWS.Request

Returns a list of requested findings from standard scans.

createScan(params = {}, callback) ⇒ AWS.Request

Use to create a scan using code uploaded to an Amazon S3 bucket.

createUploadUrl(params = {}, callback) ⇒ AWS.Request

Generates a pre-signed URL, request headers used to upload a code resource, and code artifact identifier for the uploaded resource.

You can upload your code resource to the URL with the request headers using any HTTP client.

getAccountConfiguration(params = {}, callback) ⇒ AWS.Request

Use to get the encryption configuration for an account.

getFindings(params = {}, callback) ⇒ AWS.Request

Returns a list of all findings generated by a particular scan.

getMetricsSummary(params = {}, callback) ⇒ AWS.Request

Returns a summary of metrics for an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings.

getScan(params = {}, callback) ⇒ AWS.Request

Returns details about a scan, including whether or not a scan has completed.

listFindingsMetrics(params = {}, callback) ⇒ AWS.Request

Returns metrics about all findings in an account within a specified time range.

listScans(params = {}, callback) ⇒ AWS.Request

Returns a list of all scans in an account. Does not return EXPRESS scans.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Returns a list of all tags associated with a scan.

tagResource(params = {}, callback) ⇒ AWS.Request

Use to add one or more tags to an existing scan.

untagResource(params = {}, callback) ⇒ AWS.Request

Use to remove one or more tags from an existing scan.

updateAccountConfiguration(params = {}, callback) ⇒ AWS.Request

Use to update the encryption configuration for an account.