AuditManager / Client / get_evidence_folders_by_assessment

get_evidence_folders_by_assessment#

AuditManager.Client.get_evidence_folders_by_assessment(**kwargs)#

Gets the evidence folders from a specified assessment in Audit Manager.

Request Syntax

response = client.get_evidence_folders_by_assessment(
    assessmentId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

assessmentId (string) –
[REQUIRED]

The unique identifier for the assessment.
nextToken (string) – The pagination token that’s used to fetch the next set of results.
maxResults (integer) – Represents the maximum number of results on a page or for an API request call.

Return type:

dict

Returns:

Response Syntax

{
    'evidenceFolders': [
        {
            'name': 'string',
            'date': datetime(2015, 1, 1),
            'assessmentId': 'string',
            'controlSetId': 'string',
            'controlId': 'string',
            'id': 'string',
            'dataSource': 'string',
            'author': 'string',
            'totalEvidence': 123,
            'assessmentReportSelectionCount': 123,
            'controlName': 'string',
            'evidenceResourcesIncludedCount': 123,
            'evidenceByTypeConfigurationDataCount': 123,
            'evidenceByTypeManualCount': 123,
            'evidenceByTypeComplianceCheckCount': 123,
            'evidenceByTypeComplianceCheckIssuesCount': 123,
            'evidenceByTypeUserActivityCount': 123,
            'evidenceAwsServiceSourceCount': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- evidenceFolders (list) –
  
  The list of evidence folders that the GetEvidenceFoldersByAssessment API returned.
  - (dict) –
    
    The folder where Audit Manager stores evidence for an assessment.
    - name (string) –
      
      The name of the evidence folder.
    - date (datetime) –
      
      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.
- nextToken (string) –
  
  The pagination token that’s used to fetch the next set of results.

Exceptions

AuditManager.Client.exceptions.ResourceNotFoundException
AuditManager.Client.exceptions.AccessDeniedException
AuditManager.Client.exceptions.ValidationException
AuditManager.Client.exceptions.InternalServerException