Skip to content

Signal

Source code in docs_src/capo_guardduty/types/signal.py
class Signal(TypedDict, closed=True):
    uid: NotRequired["capo_guardduty.types.string.String"]
    """<p>The unique identifier of the signal.</p>"""
    type: NotRequired["capo_guardduty.types.signal_type.SignalType"]
    """<p>The type of the signal used to identify an attack sequence.</p> <p>Signals can be GuardDuty findings or activities observed in data sources that GuardDuty monitors. For more information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_data-sources.html">Foundational data sources</a> in the <i>Amazon GuardDuty User Guide</i>.</p> <p>A signal type can be one of the valid values listed in this API. Here are the related descriptions:</p> <ul> <li> <p> <code>FINDING</code> - Individually generated GuardDuty finding.</p> </li> <li> <p> <code>CLOUD_TRAIL</code> - Activity observed from CloudTrail logs</p> </li> <li> <p> <code>S3_DATA_EVENTS</code> - Activity observed from CloudTrail data events for S3. Activities associated with this type will show up only when you have enabled GuardDuty S3 Protection feature in your account. For more information about S3 Protection and steps to enable it, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/s3-protection.html">S3 Protection</a> in the <i>Amazon GuardDuty User Guide</i>.</p> </li> </ul>"""
    description: NotRequired[
        "capo_guardduty.types.signal_description.SignalDescription"
    ]
    """<p>The description of the signal.</p>"""
    name: NotRequired["capo_guardduty.types.string.String"]
    """<p>The name of the signal. For example, when signal type is <code>FINDING</code>, the signal name is the name of the finding.</p>"""
    created_at: NotRequired["capo_guardduty.types.timestamp.Timestamp"]
    """<p>The timestamp when the first finding or activity related to this signal was observed.</p>"""
    updated_at: NotRequired["capo_guardduty.types.timestamp.Timestamp"]
    """<p>The timestamp when this signal was last observed.</p>"""
    first_seen_at: NotRequired["capo_guardduty.types.timestamp.Timestamp"]
    """<p>The timestamp when the first finding or activity related to this signal was observed.</p>"""
    last_seen_at: NotRequired["capo_guardduty.types.timestamp.Timestamp"]
    """<p>The timestamp when the last finding or activity related to this signal was observed.</p>"""
    severity: NotRequired["capo_guardduty.types.double.Double"]
    """<p>The severity associated with the signal. For more information about severity, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings-severity.html">Findings severity levels</a> in the <i>Amazon GuardDuty User Guide</i>.</p>"""
    count: NotRequired["capo_guardduty.types.integer.Integer"]
    """<p>The number of times this signal was observed.</p>"""
    resource_uids: NotRequired["capo_guardduty.types.resource_uids.ResourceUids"]
    """<p>Information about the unique identifiers of the resources involved in the signal.</p>"""
    actor_ids: NotRequired["capo_guardduty.types.actor_ids.ActorIds"]
    """<p>Information about the IDs of the threat actors involved in the signal.</p>"""
    endpoint_ids: NotRequired["capo_guardduty.types.endpoint_ids.EndpointIds"]
    """<p>Information about the endpoint IDs associated with this signal.</p>"""
    signal_indicators: NotRequired["capo_guardduty.types.indicators.Indicators"]
    """<p>Contains information about the indicators associated with the signals.</p>"""
    activities: NotRequired["capo_guardduty.types.activities.Activities"]
    """<p>Contains information about the activities, such as API calls, that were observed for this signal.</p>"""

activities instance-attribute

activities: NotRequired[Activities]

Contains information about the activities, such as API calls, that were observed for this signal.

actor_ids instance-attribute

actor_ids: NotRequired[ActorIds]

Information about the IDs of the threat actors involved in the signal.

count instance-attribute

count: NotRequired[Integer]

The number of times this signal was observed.

created_at instance-attribute

created_at: NotRequired[Timestamp]

The timestamp when the first finding or activity related to this signal was observed.

description instance-attribute

description: NotRequired[SignalDescription]

The description of the signal.

endpoint_ids instance-attribute

endpoint_ids: NotRequired[EndpointIds]

Information about the endpoint IDs associated with this signal.

first_seen_at instance-attribute

first_seen_at: NotRequired[Timestamp]

The timestamp when the first finding or activity related to this signal was observed.

last_seen_at instance-attribute

last_seen_at: NotRequired[Timestamp]

The timestamp when the last finding or activity related to this signal was observed.

name instance-attribute

name: NotRequired[String]

The name of the signal. For example, when signal type is FINDING, the signal name is the name of the finding.

resource_uids instance-attribute

resource_uids: NotRequired[ResourceUids]

Information about the unique identifiers of the resources involved in the signal.

severity instance-attribute

severity: NotRequired[Double]

The severity associated with the signal. For more information about severity, see Findings severity levels in the Amazon GuardDuty User Guide.

signal_indicators instance-attribute

signal_indicators: NotRequired[Indicators]

Contains information about the indicators associated with the signals.

type instance-attribute

type: NotRequired[SignalType]

The type of the signal used to identify an attack sequence.

Signals can be GuardDuty findings or activities observed in data sources that GuardDuty monitors. For more information, see Foundational data sources in the Amazon GuardDuty User Guide.

A signal type can be one of the valid values listed in this API. Here are the related descriptions:

  • FINDING - Individually generated GuardDuty finding.

  • CLOUD_TRAIL - Activity observed from CloudTrail logs

  • S3_DATA_EVENTS - Activity observed from CloudTrail data events for S3. Activities associated with this type will show up only when you have enabled GuardDuty S3 Protection feature in your account. For more information about S3 Protection and steps to enable it, see S3 Protection in the Amazon GuardDuty User Guide.

uid instance-attribute

uid: NotRequired[String]

The unique identifier of the signal.

updated_at instance-attribute

updated_at: NotRequired[Timestamp]

The timestamp when this signal was last observed.