AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . codeguru-security ]

get-findings

Description

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

See also: AWS API Documentation

get-findings is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: findings

Synopsis

  get-findings
--scan-name <value>
[--status <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--scan-name (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:

  • Closed
  • Open
  • All

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

findings -> (list)

A list of findings generated by the specified scan.

(structure)

Information about a finding that was detected in your code.

createdAt -> (timestamp)

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 -> (list)

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.

(string)

generatorId -> (string)

The identifier for the component that generated a finding such as AWSCodeGuruSecurity or AWSInspector.

id -> (string)

The identifier for a finding.

remediation -> (structure)

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

recommendation -> (structure)

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 -> (list)

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

(structure)

Information about the suggested code fix to remediate a finding.

code -> (string)

The suggested code to add to your file.

description -> (string)

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

resource -> (structure)

The resource where Amazon CodeGuru Security detected a finding.

id -> (string)

The identifier for the resource.

subResourceId -> (string)

The identifier for a section of the resource, such as an AWS Lambda layer.

ruleId -> (string)

The identifier for the rule that generated the finding.

severity -> (string)

The severity of the finding.

status -> (string)

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

title -> (string)

The title of the finding.

type -> (string)

The type of finding.

updatedAt -> (timestamp)

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

vulnerability -> (structure)

An object that describes the detected security vulnerability.

filePath -> (structure)

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

codeSnippet -> (list)

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

(structure)

The line of code where a finding was detected.

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 -> (list)

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

(string)

relatedVulnerabilities -> (list)

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

(string)

nextToken -> (string)

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