AwsSecurityFinding ¶

class AwsSecurityFinding(TypedDict, closed=True):
    schema_version: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The schema version that a finding is formatted for. The value is <code>2018-10-08</code>.</p>"""
    id: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The security findings provider-specific identifier for a finding.</p> <p>Length Constraints: Minimum length of 1. Maximum length of 512.</p>"""
    product_arn: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The ARN generated by Security Hub CSPM that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub CSPM, or the ARN for a custom integration.</p> <p>Length Constraints: Minimum length of 12. Maximum length of 2048.</p>"""
    product_name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The name of the product that generated the finding.</p> <p>Security Hub CSPM populates this attribute automatically for each finding. You cannot update this attribute with <code>BatchImportFindings</code> or <code>BatchUpdateFindings</code>. The exception to this is a custom integration.</p> <p>When you use the Security Hub CSPM console or API to filter findings by product name, you use this attribute.</p> <p>Length Constraints: Minimum length of 1. Maximum length of 128.</p>"""
    company_name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The name of the company for the product that generated the finding.</p> <p>Security Hub CSPM populates this attribute automatically for each finding. You cannot update this attribute with <code>BatchImportFindings</code> or <code>BatchUpdateFindings</code>. The exception to this is a custom integration.</p> <p>When you use the Security Hub CSPM console or API to filter findings by company name, you use this attribute.</p> <p>Length Constraints: Minimum length of 1. Maximum length of 128. </p>"""
    region: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The Region from which the finding was generated.</p> <p>Security Hub CSPM populates this attribute automatically for each finding. You cannot update it using <code>BatchImportFindings</code> or <code>BatchUpdateFindings</code>.</p> <p>Length Constraints: Minimum length of 1. Maximum length of 16. </p>"""
    generator_id: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security findings providers' solutions, this generator can be called a rule, a check, a detector, a plugin, or something else.</p> <p>Length Constraints: Minimum length of 1. Maximum length of 512.</p>"""
    aws_account_id: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The Amazon Web Services account ID that a finding is generated in.</p> <p>Length Constraints: 12.</p>"""
    types: NotRequired["capo_securityhub.types.type_list.TypeList"]
    """<p>One or more finding types in the format of <code>namespace/category/classifier</code> that classify a finding.</p> <p>Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications</p> <p>Array Members: Maximum number of 50 items.</p>"""
    first_observed_at: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>Indicates when the security findings provider first observed the potential security issue that a finding captured.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    last_observed_at: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>Indicates when the security findings provider most recently observed a change in the resource that is involved in the finding.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    created_at: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>Indicates when the security findings provider created the potential security issue that a finding captured.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    updated_at: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>Indicates when the security findings provider last updated the finding record.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    severity: NotRequired["capo_securityhub.types.severity.Severity"]
    """<p>A finding's severity.</p>"""
    confidence: NotRequired["capo_securityhub.types.integer.Integer"]
    """<p>A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.</p> <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.</p>"""
    criticality: NotRequired["capo_securityhub.types.integer.Integer"]
    """<p>The level of importance assigned to the resources associated with the finding.</p> <p>A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.</p>"""
    title: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>A finding's title. <code>Title</code> is a required property.</p> <p>Length Constraints: Minimum length of 1. Maximum length of 256.</p>"""
    description: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>A finding's description. <code>Description</code> is a required property.</p> <p>Length Constraints: Minimum length of 1. Maximum length of 1024.</p>"""
    remediation: NotRequired["capo_securityhub.types.remediation.Remediation"]
    """<p>A data type that describes the remediation options for a finding.</p>"""
    source_url: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>A URL that links to a page about the current finding in the security findings provider's solution.</p>"""
    product_fields: NotRequired["capo_securityhub.types.field_map.FieldMap"]
    """<p>A data type where security findings providers can include additional solution-specific details that aren't part of the defined <code>AwsSecurityFinding</code> format.</p> <p>Can contain up to 50 key-value pairs. For each key-value pair, the key can contain up to 128 characters, and the value can contain up to 2048 characters.</p>"""
    user_defined_fields: NotRequired["capo_securityhub.types.field_map.FieldMap"]
    """<p>A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.</p> <p>Can contain up to 50 key-value pairs. For each key-value pair, the key can contain up to 128 characters, and the value can contain up to 1024 characters.</p>"""
    malware: NotRequired["capo_securityhub.types.malware_list.MalwareList"]
    """<p>A list of malware related to a finding.</p> <p>Array Members: Maximum number of 5 items.</p>"""
    network: NotRequired["capo_securityhub.types.network.Network"]
    """<p>The details of network-related information about a finding.</p>"""
    network_path: NotRequired[
        "capo_securityhub.types.network_path_list.NetworkPathList"
    ]
    """<p>Provides information about a network path that is relevant to a finding. Each entry under <code>NetworkPath</code> represents a component of that path.</p>"""
    process: NotRequired["capo_securityhub.types.process_details.ProcessDetails"]
    """<p>The details of process-related information about a finding.</p>"""
    threats: NotRequired["capo_securityhub.types.threat_list.ThreatList"]
    """<p>Details about the threat detected in a security finding and the file paths that were affected by the threat. </p> <p>Array Members: Minimum number of 1 item. Maximum number of 32 items.</p>"""
    threat_intel_indicators: NotRequired[
        "capo_securityhub.types.threat_intel_indicator_list.ThreatIntelIndicatorList"
    ]
    """<p>Threat intelligence details related to a finding.</p> <p>Array Members: Minimum number of 1 item. Maximum number of 5 items.</p>"""
    resources: NotRequired["capo_securityhub.types.resource_list.ResourceList"]
    """<p>A set of resource data types that describe the resources that the finding refers to.</p> <p>Array Members: Minimum number of 1 item. Maximum number of 32 items.</p>"""
    compliance: NotRequired["capo_securityhub.types.compliance.Compliance"]
    """<p>This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported security standard, such as CIS Amazon Web Services Foundations. Contains security standard-related finding details.</p>"""
    verification_state: NotRequired[
        "capo_securityhub.types.verification_state.VerificationState"
    ]
    """<p>Indicates the veracity of a finding. </p>"""
    workflow_state: NotRequired["capo_securityhub.types.workflow_state.WorkflowState"]
    """<p>The workflow state of a finding. </p>"""
    workflow: NotRequired["capo_securityhub.types.workflow.Workflow"]
    """<p>Provides information about the status of the investigation into a finding.</p>"""
    record_state: NotRequired["capo_securityhub.types.record_state.RecordState"]
    """<p>The record state of a finding.</p>"""
    related_findings: NotRequired[
        "capo_securityhub.types.related_finding_list.RelatedFindingList"
    ]
    """<p>A list of related findings.</p> <p>Array Members: Minimum number of 1 item. Maximum number of 10 items.</p>"""
    note: NotRequired["capo_securityhub.types.note.Note"]
    """<p>A user-defined note added to a finding.</p>"""
    vulnerabilities: NotRequired[
        "capo_securityhub.types.vulnerability_list.VulnerabilityList"
    ]
    """<p>Provides a list of vulnerabilities associated with the findings.</p>"""
    patch_summary: NotRequired["capo_securityhub.types.patch_summary.PatchSummary"]
    """<p>Provides an overview of the patch compliance status for an instance against a selected compliance standard.</p>"""
    action: NotRequired["capo_securityhub.types.action.Action"]
    """<p>Provides details about an action that affects or that was taken on a resource.</p>"""
    finding_provider_fields: NotRequired[
        "capo_securityhub.types.finding_provider_fields.FindingProviderFields"
    ]
    """<p>In a <code>BatchImportFindings</code> request, finding providers use <code>FindingProviderFields</code> to provide and update their own values for confidence, criticality, related findings, severity, and types.</p>"""
    sample: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Indicates whether the finding is a sample finding.</p>"""
    generator_details: NotRequired[
        "capo_securityhub.types.generator_details.GeneratorDetails"
    ]
    """<p>Provides metadata for the Amazon CodeGuru detector associated with a finding. This field pertains to findings that relate to Lambda functions. Amazon Inspector identifies policy violations and vulnerabilities in Lambda function code based on internal detectors developed in collaboration with Amazon CodeGuru. Security Hub CSPM receives those findings. </p>"""
    processed_at: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>A timestamp that indicates when Security Hub CSPM received a finding and begins to process it.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    aws_account_name: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The name of the Amazon Web Services account from which a finding was generated. </p> <p>Length Constraints: Minimum length of 1. Maximum length of 50. </p>"""
    detection: NotRequired["capo_securityhub.types.detection.Detection"]
    """<p> Provides details about an Amazon GuardDuty Extended Threat Detection attack sequence. GuardDuty generates an attack sequence finding when multiple events align to a potentially suspicious activity. To receive GuardDuty attack sequence findings in Security Hub CSPM, you must have GuardDuty enabled. For more information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-extended-threat-detection.html">GuardDuty Extended Threat Detection </a> in the <i>Amazon GuardDuty User Guide</i>. </p>"""