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

get-evidence-folder

Description

Gets an evidence folder from a specified assessment in Audit Manager.

See also: AWS API Documentation

Synopsis

  get-evidence-folder
--assessment-id <value>
--control-set-id <value>
--evidence-folder-id <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

--assessment-id (string)

The unique identifier for the assessment.

--control-set-id (string)

The unique identifier for the control set.

--evidence-folder-id (string)

The unique identifier for the folder that the evidence is stored in.

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

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

evidenceFolder -> (structure)

The folder that the evidence is stored in.

name -> (string)

The name of the evidence folder.

date -> (timestamp)

The date when the first evidence was added to the evidence folder.

assessmentId -> (string)

The identifier for the assessment.

controlSetId -> (string)

The identifier for the control set.

controlId -> (string)

The unique identifier for the control.

id -> (string)

The identifier for the folder that the evidence is stored in.

dataSource -> (string)

The Amazon Web Service that the evidence was collected from.

author -> (string)

The name of the user who created the evidence folder.

totalEvidence -> (integer)

The total amount of evidence in the evidence folder.

assessmentReportSelectionCount -> (integer)

The total count of evidence that's included in the assessment report.

controlName -> (string)

The name of the control.

evidenceResourcesIncludedCount -> (integer)

The amount of evidence that's included in the evidence folder.

evidenceByTypeConfigurationDataCount -> (integer)

The number of evidence that falls under the configuration data category. This evidence is collected from configuration snapshots of other Amazon Web Services such as Amazon EC2, Amazon S3, or IAM.

evidenceByTypeManualCount -> (integer)

The number of evidence that falls under the manual category. This evidence is imported manually.

evidenceByTypeComplianceCheckCount -> (integer)

The number of evidence that falls under the compliance check category. This evidence is collected from Config or Security Hub.

evidenceByTypeComplianceCheckIssuesCount -> (integer)

The total number of issues that were reported directly from Security Hub, Config, or both.

evidenceByTypeUserActivityCount -> (integer)

The number of evidence that falls under the user activity category. This evidence is collected from CloudTrail logs.

evidenceAwsServiceSourceCount -> (integer)

The total number of Amazon Web Services resources that were assessed to generate the evidence.