SecurityAgent / Paginator / ListFindings

ListFindings

class SecurityAgent.Paginator.ListFindings

paginator = client.get_paginator('list_findings')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SecurityAgent.Client.list_findings().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    pentestJobId='string',
    codeReviewJobId='string',
    agentSpaceId='string',
    riskType='string',
    riskLevel='UNKNOWN'|'INFORMATIONAL'|'LOW'|'MEDIUM'|'HIGH'|'CRITICAL',
    status='ACTIVE'|'RESOLVED'|'ACCEPTED'|'FALSE_POSITIVE',
    confidence='FALSE_POSITIVE'|'UNCONFIRMED'|'LOW'|'MEDIUM'|'HIGH',
    name='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• pentestJobId (string) – The unique identifier of the pentest job to list findings for.

• codeReviewJobId (string) – The unique identifier of the code review job to list findings for. Mutually exclusive with pentestJobId.

• agentSpaceId (string) –

  [REQUIRED]

  The unique identifier of the agent space.

• riskType (string) – Filter findings by risk type.

• riskLevel (string) – Filter findings by risk level.

• status (string) – Filter findings by status.

• confidence (string) – Filter findings by confidence level.

• name (string) – Filter findings by name.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'findingsSummaries': [
        {
            'findingId': 'string',
            'agentSpaceId': 'string',
            'pentestId': 'string',
            'pentestJobId': 'string',
            'codeReviewId': 'string',
            'codeReviewJobId': 'string',
            'name': 'string',
            'status': 'ACTIVE'|'RESOLVED'|'ACCEPTED'|'FALSE_POSITIVE',
            'riskType': 'string',
            'riskLevel': 'UNKNOWN'|'INFORMATIONAL'|'LOW'|'MEDIUM'|'HIGH'|'CRITICAL',
            'confidence': 'FALSE_POSITIVE'|'UNCONFIRMED'|'LOW'|'MEDIUM'|'HIGH',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Output for the ListFindings operation.

  • findingsSummaries (list) –

    The list of finding summaries.

    • (dict) –

      Contains summary information about a security finding.

      • findingId (string) –

        The unique identifier of the finding.

      • agentSpaceId (string) –

        The unique identifier of the agent space associated with the finding.

      • pentestId (string) –

        The unique identifier of the pentest associated with the finding.

      • pentestJobId (string) –

        The unique identifier of the pentest job that produced the finding.

      • codeReviewId (string) –

        The unique identifier of the code review associated with the finding.

      • codeReviewJobId (string) –

        The unique identifier of the code review job that produced the finding.

      • name (string) –

        The name of the finding.

      • status (string) –

        The current status of the finding.

      • riskType (string) –

        The type of security risk identified by the finding.

      • riskLevel (string) –

        The risk level of the finding.

      • confidence (string) –

        The confidence level of the finding.

      • createdAt (datetime) –

        The date and time the finding was created, in UTC format.

      • updatedAt (datetime) –

        The date and time the finding was last updated, in UTC format.

  • NextToken (string) –

    A token to resume pagination.