mage.api_resources.lead module¶

class mage.api_resources.lead.Lead¶

Bases: mage.api_resources.abstract.listable_api_resource.ListableAPIResource, mage.api_resources.abstract.mutable_api_resource.MutableAPIResource

assessment_run_id¶

ID of the associated assessment run

Type: str

confidence¶

Confidence level of the lead

Type: mage.schema.Confidence

created_at¶

When the lead was created (e.g., ‘2020-01-02T03:04:56.789Z’)

Type: str

description¶

Description of the lead

Type: str

evidence¶

Evidence supporting the lead

Type: mage.schema.AWSJSON

file_links¶

Associated files

Type: list of str

files¶

Associated files

Type: list of mage.schema.S3Object

id¶

Unique lead ID

Type: str

references¶

List of references to additional information

Type: list of str

title¶

Title of the lead

Type: str

updated_at¶

When the lead was last updated (e.g., ‘2020-01-02T03:04:56.789Z’)

Type: str

property assessment¶: Warning

Not Implemented. Use assessment_run instead.

property assessment_run¶

The associated assessment run.

Returns: AssessmentRun

classmethod create(title, description, assessment_run_id, **kwargs)¶

Creates a lead for an assessment run.

Parameters

title (str) –
description (str) –
assessment_run_id (str) –
**kwargs – Additional arguments to initialize the lead with

Returns

Lead

Example

>>> import mage
>>> mage.connect()
>>> mage.Lead.create('Default Password on WEBSRV1', 'Password has not been changed yet.', '11111111-1111-1111-1111-111111111111')