Class: AWS.CodeGuruSecurity

var params = {
  resourceId: { /* required */
    codeArtifactId: 'STRING_VALUE'
  },
  scanName: 'STRING_VALUE', /* required */
  analysisType: Security | All,
  clientToken: 'STRING_VALUE',
  scanType: Standard | Express,
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
codegurusecurity.createScan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • analysisType — (String)

    The type of analysis you want CodeGuru Security to perform in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings. Defaults to Security type if missing.

    Possible values include:
    • "Security"
    • "All"
  • clientToken — (String)

    The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.

    If a token is not provided, the SDK will use a version 4 UUID.
  • resourceId — (map)

    The identifier for the resource object to be scanned.

    • codeArtifactId — (String)

      The identifier for the code file uploaded to the resource object. Returned by CreateUploadUrl when you upload resources to be scanned.

  • scanName — (String)

    The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a STANDARD scan type.

  • scanType — (String)

    The type of scan, either Standard or Express. Defaults to Standard type if missing.

    Express scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. Standard scans have standard resource limits and use the full set of detectors to analyze your code.

    Possible values include:
    • "Standard"
    • "Express"
  • tags — (map<String>)

    An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:

    • A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.

    • An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • resourceId — (map)

      The identifier for the resource object that contains resources that were scanned.

      • codeArtifactId — (String)

        The identifier for the code file uploaded to the resource object. Returned by CreateUploadUrl when you upload resources to be scanned.

    • runId — (String)

      UUID that identifies the individual scan run.

    • scanName — (String)

      The name of the scan.

    • scanNameArn — (String)

      The ARN for the scan name.

    • scanState — (String)

      The current state of the scan. Returns either InProgress, Successful, or Failed.

      Possible values include:
      • "InProgress"
      • "Successful"
      • "Failed"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  scanName: 'STRING_VALUE' /* required */
};
codegurusecurity.createUploadUrl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • scanName — (String)

    The name of the scan that will use the uploaded resource. CodeGuru Security uses the unique scan name to track revisions across multiple scans of the same resource. Use this scanName when you call CreateScan on the code resource you upload to this URL.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • codeArtifactId — (String)

      The identifier for the uploaded code resource. Pass this to CreateScan to use the uploaded resources.

    • requestHeaders — (map<String>)

      A set of key-value pairs that contain the required headers when uploading your resource.

    • s3Url — (String)

      A pre-signed S3 URL. You can upload the code file you want to scan with the required requestHeaders using any HTTP client.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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

Parameters:

• params (Object) (defaults to: {})

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • encryptionConfig — (map)

      An EncryptionConfig object that contains the KMS key ARN that is used for encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify your own key, call UpdateAccountConfiguration. If you do not specify a customer-managed key, returns empty.

      • kmsKeyArn — (String)

        The KMS key ARN that is used for encryption. If an AWS-managed key is used for encryption, returns empty.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  scanName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  status: Closed | Open | All
};
codegurusecurity.getFindings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 1000 results.

  • nextToken — (String)

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

  • scanName — (String)

    The name of the scan you want to retrieve findings from.

  • status — (String)

    The status of the findings you want to get. Pass either Open, Closed, or All.

    Possible values include:
    • "Closed"
    • "Open"
    • "All"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • findings — (Array<map>)

      A list of findings generated by the specified scan.

      • createdAt — (Date)

        The time when the finding was created.

      • description — (String)

        A description of the finding.

      • detectorId — (String)

        The identifier for the detector that detected the finding in your code. A detector is a defined rule based on industry standards and AWS best practices.

      • detectorName — (String)

        The name of the detector that identified the security vulnerability in your code.

      • detectorTags — (Array<String>)

        One or more tags or categorizations that are associated with a detector. These tags are defined by type, programming language, or other classification such as maintainability or consistency.

      • generatorId — (String)

        The identifier for the component that generated a finding such as AmazonCodeGuruSecurity.

      • id — (String)

        The identifier for a finding.

      • remediation — (map)

        An object that contains the details about how to remediate a finding.

        • recommendation — (map)

          An object that contains information about the recommended course of action to remediate a finding.

          • text — (String)

            The recommended course of action to remediate the finding.

          • url — (String)

            The URL address to the recommendation for remediating the finding.

        • suggestedFixes — (Array<map>)

          A list of SuggestedFix objects. Each object contains information about a suggested code fix to remediate the finding.

          • code — (String)

            The suggested code fix. If applicable, includes code patch to replace your source code.

          • description — (String)

            A description of the suggested code fix and why it is being suggested.

      • resource — (map)

        The resource where Amazon CodeGuru Security detected a finding.

        • id — (String)

          The scanName of the scan that was run on the resource.

        • subResourceId — (String)

          The identifier for a section of the resource.

      • ruleId — (String)

        The identifier for the rule that generated the finding.

      • severity — (String)

        The severity of the finding. Severity can be critical, high, medium, low, or informational. For information on severity levels, see Finding severity in the Amazon CodeGuru Security User Guide.

        Possible values include:
        • "Critical"
        • "High"
        • "Medium"
        • "Low"
        • "Info"
      • status — (String)

        The status of the finding. A finding status can be open or closed.

        Possible values include:
        • "Closed"
        • "Open"
        • "All"
      • title — (String)

        The title of the finding.

      • type — (String)

        The type of finding.

      • updatedAt — (Date)

        The time when the finding was last updated. Findings are updated when you remediate them or when the finding code location changes.

      • vulnerability — (map)

        An object that describes the detected security vulnerability.

        • filePath — (map)

          An object that describes the location of the detected security vulnerability in your code.

          • codeSnippet — (Array<map>)

            A list of CodeLine objects that describe where the security vulnerability appears in your code.

            • content — (String)

              The code that contains a vulnerability.

            • number — (Integer)

              The code line number.

          • endLine — (Integer)

            The last line number of the code snippet where the security vulnerability appears in your code.

          • name — (String)

            The name of the file.

          • path — (String)

            The path to the resource with the security vulnerability.

          • startLine — (Integer)

            The first line number of the code snippet where the security vulnerability appears in your code.

        • id — (String)

          The identifier for the vulnerability.

        • itemCount — (Integer)

          The number of times the vulnerability appears in your code.

        • referenceUrls — (Array<String>)

          One or more URL addresses that contain details about a vulnerability.

        • relatedVulnerabilities — (Array<String>)

          One or more vulnerabilities that are related to the vulnerability being described.

    • nextToken — (String)

      A pagination token. You can use this in future calls to GetFindings to continue listing results after the current page.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  date: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
};
codegurusecurity.getMetricsSummary(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • date — (Date)

    The date you want to retrieve summary metrics from, rounded to the nearest day. The date must be within the past two years.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • metricsSummary — (map)

      The summary metrics from the specified date.

      • categoriesWithMostFindings — (Array<map>)

        A list of CategoryWithFindingNum objects for the top 5 finding categories with the most findings.

        • categoryName — (String)

          The name of the finding category. A finding category is determined by the detector that detected the finding.

        • findingNumber — (Integer)

          The number of open findings in the category.

      • date — (Date)

        The date from which the metrics summary information was retrieved.

      • openFindings — (map)

        The number of open findings of each severity.

        • critical — (Float)

          A numeric value corresponding to a critical finding.

        • high — (Float)

          A numeric value corresponding to a high severity finding.

        • info — (Float)

          A numeric value corresponding to an informational finding.

        • low — (Float)

          A numeric value corresponding to a low severity finding.

        • medium — (Float)

          A numeric value corresponding to a medium severity finding.

      • scansWithMostOpenCriticalFindings — (Array<map>)

        A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings.

        • findingNumber — (Integer)

          The number of findings generated by a scan.

        • scanName — (String)

          The name of the scan.

      • scansWithMostOpenFindings — (Array<map>)

        A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings.

        • findingNumber — (Integer)

          The number of findings generated by a scan.

        • scanName — (String)

          The name of the scan.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  scanName: 'STRING_VALUE', /* required */
  runId: 'STRING_VALUE'
};
codegurusecurity.getScan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • runId — (String)

    UUID that identifies the individual scan run you want to view details about. You retrieve this when you call the CreateScan operation. Defaults to the latest scan run if missing.

  • scanName — (String)

    The name of the scan you want to view details about.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • analysisType — (String)

      The type of analysis CodeGuru Security performed in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings.

      Possible values include:
      • "Security"
      • "All"
    • createdAt — (Date)

      The time the scan was created.

    • errorMessage — (String)

      Details about the error that causes a scan to fail to be retrieved.

    • numberOfRevisions — (Integer)

      The number of times a scan has been re-run on a revised resource.

    • runId — (String)

      UUID that identifies the individual scan run.

    • scanName — (String)

      The name of the scan.

    • scanNameArn — (String)

      The ARN for the scan name.

    • scanState — (String)

      The current state of the scan. Returns either InProgress, Successful, or Failed.

      Possible values include:
      • "InProgress"
      • "Successful"
      • "Failed"
    • updatedAt — (Date)

      The time when the scan was last updated. Only available for STANDARD scan types.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  endDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  startDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codegurusecurity.listFindingsMetrics(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • endDate — (Date)

    The end date of the interval which you want to retrieve metrics from. Round to the nearest day.

  • maxResults — (Integer)

    The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 1000 results.

  • nextToken — (String)

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

  • startDate — (Date)

    The start date of the interval which you want to retrieve metrics from. Rounds to the nearest day.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • findingsMetrics — (Array<map>)

      A list of AccountFindingsMetric objects retrieved from the specified time interval.

      • closedFindings — (map)

        The number of closed findings of each severity on the specified date.

        • critical — (Float)

          A numeric value corresponding to a critical finding.

        • high — (Float)

          A numeric value corresponding to a high severity finding.

        • info — (Float)

          A numeric value corresponding to an informational finding.

        • low — (Float)

          A numeric value corresponding to a low severity finding.

        • medium — (Float)

          A numeric value corresponding to a medium severity finding.

      • date — (Date)

        The date from which the findings metrics were retrieved.

      • meanTimeToClose — (map)

        The average time in days it takes to close findings of each severity as of a specified date.

        • critical — (Float)

          A numeric value corresponding to a critical finding.

        • high — (Float)

          A numeric value corresponding to a high severity finding.

        • info — (Float)

          A numeric value corresponding to an informational finding.

        • low — (Float)

          A numeric value corresponding to a low severity finding.

        • medium — (Float)

          A numeric value corresponding to a medium severity finding.

      • newFindings — (map)

        The number of new findings of each severity on the specified date.

        • critical — (Float)

          A numeric value corresponding to a critical finding.

        • high — (Float)

          A numeric value corresponding to a high severity finding.

        • info — (Float)

          A numeric value corresponding to an informational finding.

        • low — (Float)

          A numeric value corresponding to a low severity finding.

        • medium — (Float)

          A numeric value corresponding to a medium severity finding.

      • openFindings — (map)

        The number of open findings of each severity as of the specified date.

        • critical — (Float)

          A numeric value corresponding to a critical finding.

        • high — (Float)

          A numeric value corresponding to a high severity finding.

        • info — (Float)

          A numeric value corresponding to an informational finding.

        • low — (Float)

          A numeric value corresponding to a low severity finding.

        • medium — (Float)

          A numeric value corresponding to a medium severity finding.

    • nextToken — (String)

      A pagination token. You can use this in future calls to ListFindingMetrics to continue listing results after the current page.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codegurusecurity.listScans(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 100 results.

  • nextToken — (String)

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      A pagination token. You can use this in future calls to ListScans to continue listing results after the current page.

    • summaries — (Array<map>)

      A list of ScanSummary objects with information about all scans in an account.

      • createdAt — required — (Date)

        The time when the scan was created.

      • runId — required — (String)

        The identifier for the scan run.

      • scanName — required — (String)

        The name of the scan.

      • scanNameArn — (String)

        The ARN for the scan name.

      • scanState — required — (String)

        The state of the scan. A scan can be In Progress, Complete, or Failed.

        Possible values include:
        • "InProgress"
        • "Successful"
        • "Failed"
      • updatedAt — (Date)

        The time the scan was last updated. A scan is updated when it is re-run.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
codegurusecurity.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      An array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts:

      • A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.

      • An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
codegurusecurity.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.

  • tags — (map<String>)

    An array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts:

    • A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.

    • An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
codegurusecurity.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.

  • tagKeys — (Array<String>)

    A list of keys for each tag you want to remove from a scan.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  encryptionConfig: { /* required */
    kmsKeyArn: 'STRING_VALUE'
  }
};
codegurusecurity.updateAccountConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • encryptionConfig — (map)

    The customer-managed KMS key ARN you want to use for encryption. If not specified, CodeGuru Security will use an AWS-managed key for encryption. If you previously specified a customer-managed KMS key and want CodeGuru Security to use an AWS-managed key for encryption instead, pass nothing.

    • kmsKeyArn — (String)

      The KMS key ARN that is used for encryption. If an AWS-managed key is used for encryption, returns empty.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • encryptionConfig — (map)

      An EncryptionConfig object that contains the KMS key ARN that is used for encryption. If you did not specify a customer-managed KMS key in the request, returns empty.

      • kmsKeyArn — (String)

        The KMS key ARN that is used for encryption. If an AWS-managed key is used for encryption, returns empty.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.