SecurityAgent / Client / batch_export_findings

batch_export_findings

SecurityAgent.Client.batch_export_findings(**kwargs)

Exports a batch of findings to the connected issue tracker as issues.

See also: AWS API Documentation

Request Syntax

response = client.batch_export_findings(
    agentSpaceId='string',
    pentestJobId='string',
    codeReviewJobId='string',
    issueDestination={
        'integrationId': 'string',
        'projectKey': 'string'
    },
    findingIds=[
        'string',
    ]
)
Parameters:

  • agentSpaceId (string) –

    [REQUIRED]

    The identifier of the agent space where the job exists.

  • pentestJobId (string) – The identifier of the penetration test job. This parameter is mutually exclusive with codeReviewJobId.

  • codeReviewJobId (string) – The identifier of the code review job. This parameter is mutually exclusive with pentestJobId.

  • issueDestination (dict) –

    [REQUIRED]

    The destination issue-tracker project the findings are exported to. Must be a connected capability of the agent space.

    • integrationId (string) – [REQUIRED]

      The integration identifier for the issue-tracker provider.

    • projectKey (string) – [REQUIRED]

      The identifier of the project the issues are filed under.

  • findingIds (list) –

    [REQUIRED]

    The identifiers of the findings to export. Each must belong to the specified job.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'results': [
        {
            'findingId': 'string',
            'linkedIssue': {
                'provider': 'GITHUB'|'GITLAB'|'BITBUCKET'|'CONFLUENCE'|'AZURE_DEVOPS'|'JIRA',
                'integrationId': 'string',
                'projectKey': 'string',
                'issueKey': 'string',
                'issueId': 'string',
                'issueUrl': 'string',
                'siteUrl': 'string'
            }
        },
    ],
    'errors': [
        {
            'findingId': 'string',
            'code': 'CLIENT_ERROR'|'INTERNAL_ERROR'|'STOPPED_BY_USER',
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    The output for the BatchExportFindings operation.

    • results (list) –

      The findings whose issue was created, each with its linked issue.

      • (dict) –

        A finding whose issue was created.

        • findingId (string) –

          The identifier of the finding this result corresponds to.

        • linkedIssue (dict) –

          The issue that was created for the finding.

          • provider (string) –

            The issue-tracker provider.

          • integrationId (string) –

            The integration identifier for the issue-tracker provider.

          • projectKey (string) –

            The key of the project the issue belongs to.

          • issueKey (string) –

            The issue key.

          • issueId (string) –

            The stable numeric issue identifier.

          • issueUrl (string) –

            The issue URL.

          • siteUrl (string) –

            The Atlassian Cloud site URL.

    • errors (list) –

      The findings whose issue could not be created, each with a customer-facing reason.

      • (dict) –

        A finding whose issue could not be created, with the cause of the failure.

        • findingId (string) –

          The identifier of the finding this error corresponds to.

        • code (string) –

          The machine-readable failure category.

        • message (string) –

          A customer-facing explanation of why the issue could not be created.

Exceptions