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 . inspector2 ]

batch-get-code-snippet

Description

Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in.

See also: AWS API Documentation

Synopsis

  batch-get-code-snippet
--finding-arns <value>
[--cli-input-json <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

--finding-arns (list)

An array of finding ARNs for the findings you want to retrieve code snippets from.

(string)

Syntax:

"string" "string" ...

--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.

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--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

codeSnippetResults -> (list)

The retrieved code snippets associated with the provided finding ARNs.

(structure)

Contains information on a code snippet retrieved by Amazon Inspector from a code vulnerability finding.

codeSnippet -> (list)

Contains information on the retrieved code snippet.

(structure)

Contains information on the lines of code associated with a code snippet.

content -> (string)

The content of a line of code

lineNumber -> (integer)

The line number that a section of code is located at.

endLine -> (integer)

The line number of the last line of a code snippet.

findingArn -> (string)

The ARN of a finding that the code snippet is associated with.

startLine -> (integer)

The line number of the first line of a code snippet.

suggestedFixes -> (list)

Details of a suggested code fix.

(structure)

A suggested fix for a vulnerability in your Lambda function code.

code -> (string)

The fix's code.

description -> (string)

The fix's description.

errors -> (list)

Any errors Amazon Inspector encountered while trying to retrieve the requested code snippets.

(structure)

Contains information about any errors encountered while trying to retrieve a code snippet.

errorCode -> (string)

The error code for the error that prevented a code snippet from being retrieved.

errorMessage -> (string)

The error message received when Amazon Inspector failed to retrieve a code snippet.

findingArn -> (string)

The ARN of the finding that a code snippet couldn't be retrieved for.