Skip to content

Signal

Source code in docs_src/capo_securityhub/types/signal.py
class Signal(TypedDict, closed=True):
    type: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<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">GuardDuty foundational data sources</a> in the <i>Amazon GuardDuty User Guide</i>.</p> <p>A signal type can be one of the following values. 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 Amazon Simple Storage Service (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 the 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>"""
    id: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The identifier of the signal. </p>"""
    title: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The description of the GuardDuty finding. </p>"""
    product_arn: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The Amazon Resource Name (ARN) of the product that generated the signal. </p>"""
    resource_ids: NotRequired[
        "capo_securityhub.types.non_empty_string_list.NonEmptyStringList"
    ]
    """<p> The ARN or ID of the Amazon Web Services resource associated with the signal. </p>"""
    signal_indicators: NotRequired[
        "capo_securityhub.types.indicators_list.IndicatorsList"
    ]
    """<p> Contains information about the indicators associated with the signals in this attack sequence finding. The values for <code>SignalIndicators</code> are a subset of the values for <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_Sequence.html">SequenceIndicators</a>, but the values for these fields don't always match 1:1. </p>"""
    name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The name of the GuardDuty signal. For example, when signal type is <code>FINDING</code>, the signal name is the name of the finding. </p>"""
    created_at: NotRequired["capo_securityhub.types.long.Long"]
    """<p> The timestamp when the first finding or activity related to this signal was observed. </p>"""
    updated_at: NotRequired["capo_securityhub.types.long.Long"]
    """<p> The timestamp when this signal was last observed. </p>"""
    first_seen_at: NotRequired["capo_securityhub.types.long.Long"]
    """<p> The timestamp when the first finding or activity related to this signal was observed. </p>"""
    last_seen_at: NotRequired["capo_securityhub.types.long.Long"]
    """<p> The timestamp when the last finding or activity related to this signal was observed. </p>"""
    severity: NotRequired["capo_securityhub.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">Severity levels for GuardDuty findings</a> in the <i>Amazon GuardDuty User Guide</i>.</p>"""
    count: NotRequired["capo_securityhub.types.integer.Integer"]
    """<p> The number of times this signal was observed. </p>"""
    actor_ids: NotRequired[
        "capo_securityhub.types.non_empty_string_list.NonEmptyStringList"
    ]
    """<p> The IDs of the threat actors involved in the signal. </p>"""
    endpoint_ids: NotRequired[
        "capo_securityhub.types.non_empty_string_list.NonEmptyStringList"
    ]
    """<p>Information about the endpoint IDs associated with this signal.</p>"""

actor_ids instance-attribute

actor_ids: NotRequired[NonEmptyStringList]

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[Long]

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

endpoint_ids instance-attribute

endpoint_ids: NotRequired[NonEmptyStringList]

Information about the endpoint IDs associated with this signal.

first_seen_at instance-attribute

first_seen_at: NotRequired[Long]

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

id instance-attribute

id: NotRequired[NonEmptyString]

The identifier of the signal.

last_seen_at instance-attribute

last_seen_at: NotRequired[Long]

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

name instance-attribute

name: NotRequired[NonEmptyString]

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

product_arn instance-attribute

product_arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the product that generated the signal.

resource_ids instance-attribute

resource_ids: NotRequired[NonEmptyStringList]

The ARN or ID of the Amazon Web Services resource associated with the signal.

severity instance-attribute

severity: NotRequired[Double]

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

signal_indicators instance-attribute

signal_indicators: NotRequired[IndicatorsList]

Contains information about the indicators associated with the signals in this attack sequence finding. The values for SignalIndicators are a subset of the values for SequenceIndicators, but the values for these fields don't always match 1:1.

title instance-attribute

title: NotRequired[NonEmptyString]

The description of the GuardDuty finding.

type instance-attribute

type: NotRequired[NonEmptyString]

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 GuardDuty foundational data sources in the Amazon GuardDuty User Guide.

A signal type can be one of the following values. 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 Amazon Simple Storage Service (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 the steps to enable it, see S3 Protection in the Amazon GuardDuty User Guide.

updated_at instance-attribute

updated_at: NotRequired[Long]

The timestamp when this signal was last observed.