SecurityAgent / Client / batch_get_code_review_jobs

batch_get_code_review_jobs

SecurityAgent.Client.batch_get_code_review_jobs(**kwargs)

Retrieves information about one or more code review jobs in an agent space.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_code_review_jobs(
    codeReviewJobIds=[
        'string',
    ],
    agentSpaceId='string'
)

Parameters:

• codeReviewJobIds (list) –

  [REQUIRED]

  The list of code review job identifiers to retrieve.

  • (string) –

• agentSpaceId (string) –

  [REQUIRED]

  The unique identifier of the agent space that contains the code review jobs.

Return type:

dict

Returns:

Response Syntax

{
    'codeReviewJobs': [
        {
            'codeReviewJobId': 'string',
            'codeReviewId': 'string',
            'title': 'string',
            'overview': 'string',
            'status': 'IN_PROGRESS'|'STOPPING'|'STOPPED'|'FAILED'|'COMPLETED',
            'documents': [
                {
                    's3Location': 'string',
                    'artifactId': 'string'
                },
            ],
            'sourceCode': [
                {
                    's3Location': 'string'
                },
            ],
            'steps': [
                {
                    'name': 'PREFLIGHT'|'STATIC_ANALYSIS'|'PENTEST'|'FINALIZING',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOPPED',
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1)
                },
            ],
            'executionContext': [
                {
                    'contextType': 'ERROR'|'CLIENT_ERROR'|'WARNING'|'INFO',
                    'context': 'string',
                    'timestamp': datetime(2015, 1, 1)
                },
            ],
            'serviceRole': 'string',
            'logConfig': {
                'logGroup': 'string',
                'logStream': 'string'
            },
            'errorInformation': {
                'code': 'CLIENT_ERROR'|'INTERNAL_ERROR'|'STOPPED_BY_USER',
                'message': 'string'
            },
            'integratedRepositories': [
                {
                    'integrationId': 'string',
                    'providerResourceId': 'string'
                },
            ],
            'codeRemediationStrategy': 'AUTOMATIC'|'DISABLED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'notFound': [
        'string',
    ]
}

Response Structure

• (dict) –

  Output for the BatchGetCodeReviewJobs operation.

  • codeReviewJobs (list) –

    The list of code review jobs that were found.

    • (dict) –

      Represents a code review job, which is an execution instance of a code review. A code review job progresses through preflight, static analysis, and finalizing steps.

      • codeReviewJobId (string) –

        The unique identifier of the code review job.

      • codeReviewId (string) –

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

      • title (string) –

        The title of the code review job.

      • overview (string) –

        An overview of the code review job results.

      • status (string) –

        The current status of the code review job.

      • documents (list) –

        The list of documents providing context for the code review job.

        • (dict) –

          Represents a document that provides context for security testing.

          • s3Location (string) –

            The Amazon S3 location of the document.

          • artifactId (string) –

            The unique identifier of the artifact associated with the document.

      • sourceCode (list) –

        The list of source code repositories analyzed during the code review job.

        • (dict) –

          Represents a source code repository used for security analysis during a pentest.

          • s3Location (string) –

            The Amazon S3 location of the source code repository archive.

      • steps (list) –

        The list of steps in the code review job execution.

        • (dict) –

          Represents a step in the pentest job execution pipeline. Steps include preflight, static analysis, pentest, and finalizing.

          • name (string) –

            The name of the step. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, and FINALIZING.

          • status (string) –

            The current status of the step.

          • createdAt (datetime) –

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

          • updatedAt (datetime) –

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

      • executionContext (list) –

        The execution context messages for the code review job.

        • (dict) –

          Contains contextual information about the execution of a pentest job, such as errors, warnings, or informational messages.

          • contextType (string) –

            The type of context. Valid values include ERROR, CLIENT_ERROR, WARNING, and INFO.

          • context (string) –

            The context message.

          • timestamp (datetime) –

            The date and time the context was recorded, in UTC format.

      • serviceRole (string) –

        The IAM service role used for the code review job.

      • logConfig (dict) –

        The CloudWatch Logs configuration for the code review job.

        • logGroup (string) –

          The name of the CloudWatch log group.

        • logStream (string) –

          The name of the CloudWatch log stream.

      • errorInformation (dict) –

        Error information if the code review job encountered an error.

        • code (string) –

          The error code. Valid values include CLIENT_ERROR, INTERNAL_ERROR, and STOPPED_BY_USER.

        • message (string) –

          A message describing the error.

      • integratedRepositories (list) –

        The list of integrated repositories associated with the code review job.

        • (dict) –

          Represents a code repository that is integrated with the service through a third-party provider.

          • integrationId (string) –

            The unique identifier of the integration that provides access to the repository.

          • providerResourceId (string) –

            The provider-specific resource identifier for the repository.

      • codeRemediationStrategy (string) –

        The code remediation strategy for the code review job.

      • createdAt (datetime) –

        The date and time the code review job was created, in UTC format.

      • updatedAt (datetime) –

        The date and time the code review job was last updated, in UTC format.

  • notFound (list) –

    The list of code review job identifiers that were not found.

    • (string) –