SecurityAgent / Client / batch_get_threat_model_jobs

batch_get_threat_model_jobs

SecurityAgent.Client.batch_get_threat_model_jobs(**kwargs)

Retrieves information about one or more threat model jobs in an agent space.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_threat_model_jobs(
    threatModelJobIds=[
        'string',
    ],
    agentSpaceId='string'
)

Parameters:

• threatModelJobIds (list) –

  [REQUIRED]

  The list of threat model job identifiers to retrieve.

  • (string) –

• agentSpaceId (string) –

  [REQUIRED]

  The unique identifier of the agent space that contains the threat model jobs.

Return type:

dict

Returns:

Response Syntax

{
    'threatModelJobs': [
        {
            'threatModelJobId': 'string',
            'threatModelId': 'string',
            'agentSpaceId': 'string',
            'title': 'string',
            'status': 'IN_PROGRESS'|'STOPPING'|'STOPPED'|'FAILED'|'COMPLETED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'executionStartTime': datetime(2015, 1, 1),
            'executionEndTime': datetime(2015, 1, 1),
            'sourceCode': [
                {
                    's3Location': 'string'
                },
            ],
            'integratedRepositories': [
                {
                    'integrationId': 'string',
                    'providerResourceId': 'string'
                },
            ],
            'documents': [
                {
                    's3Location': 'string',
                    'artifactId': 'string',
                    'integratedDocument': {
                        'integrationId': 'string',
                        'resourceId': 'string'
                    }
                },
            ],
            'scopeDocs': [
                {
                    's3Location': 'string',
                    'artifactId': 'string',
                    'integratedDocument': {
                        'integrationId': 'string',
                        'resourceId': 'string'
                    }
                },
            ],
            'errorInformation': {
                'code': 'CLIENT_ERROR'|'INTERNAL_ERROR'|'STOPPED_BY_USER',
                'message': 'string'
            },
            'systemOverview': 'string'
        },
    ],
    'notFound': [
        'string',
    ]
}

Response Structure

• (dict) –

  Output for the BatchGetThreatModelJobs operation.

  • threatModelJobs (list) –

    The list of threat model jobs that were found.

    • (dict) –

      Represents a threat model job, which is an execution instance of a threat model.

      • threatModelJobId (string) –

        The unique identifier of the threat model job.

      • threatModelId (string) –

        The unique identifier of the threat model associated with the job.

      • agentSpaceId (string) –

        The unique identifier of the agent space.

      • title (string) –

        The title of the threat model job.

      • status (string) –

        The current status of the threat model job.

      • createdAt (datetime) –

        The date and time the threat model job was created, in UTC format.

      • updatedAt (datetime) –

        The date and time the threat model job was last updated, in UTC format.

      • executionStartTime (datetime) –

        The date and time the threat model job execution started, in UTC format.

      • executionEndTime (datetime) –

        The date and time the threat model job execution ended, in UTC format.

      • sourceCode (list) –

        The list of source code repositories used for threat modeling.

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

      • integratedRepositories (list) –

        The list of integrated repositories used for threat modeling.

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

      • documents (list) –

        The list of documents used for threat modeling.

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

          • integratedDocument (dict) –

            A reference to a document in an integrated third-party provider.

            • integrationId (string) –

              The identifier of the integration that provides access to the document.

            • resourceId (string) –

              The provider-specific resource identifier for the document.

      • scopeDocs (list) –

        The scoped documents for the agent to focus on during threat modeling.

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

          • integratedDocument (dict) –

            A reference to a document in an integrated third-party provider.

            • integrationId (string) –

              The identifier of the integration that provides access to the document.

            • resourceId (string) –

              The provider-specific resource identifier for the document.

      • errorInformation (dict) –

        Error information if the threat model 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.

      • systemOverview (string) –

        The system overview generated during threat modeling.

  • notFound (list) –

    The list of threat model job identifiers that were not found.

    • (string) –