capo-securityhub 0.1.0__py3-none-any.whl

capo_securityhub/types/automation_rules_action_type.py

@@ -0,0 +1,14 @@
+"""Generated from Smithy shape ``com.amazonaws.securityhub#AutomationRulesActionType``."""
+
+from typing import Literal, TypeAlias, cast
+
+AutomationRulesActionType: TypeAlias = Literal["FINDING_FIELDS_UPDATE",]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: AutomationRulesActionType) -> str:
+    return value
+
+
+def deserialize_json(data: str) -> AutomationRulesActionType:
+    return cast(AutomationRulesActionType, data)

capo_securityhub/types/automation_rules_action_type_list_v2.py

@@ -0,0 +1,39 @@
+"""Generated from Smithy shape ``com.amazonaws.securityhub#AutomationRulesActionTypeListV2``."""
+
+from typing import TYPE_CHECKING, TypeAlias
+
+if TYPE_CHECKING:
+    import capo_securityhub.types.automation_rules_action_type_object_v2
+
+AutomationRulesActionTypeListV2: TypeAlias = list[
+    "capo_securityhub.types.automation_rules_action_type_object_v2.AutomationRulesActionTypeObjectV2"
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: AutomationRulesActionTypeListV2) -> list:
+    import capo_securityhub.types.automation_rules_action_type_object_v2
+
+    out: list = []
+    for item in value:
+        out.append(
+            capo_securityhub.types.automation_rules_action_type_object_v2.serialize_json(
+                item
+            )
+        )
+    return out
+
+
+def deserialize_json(data: list) -> AutomationRulesActionTypeListV2:
+    import capo_securityhub.types.automation_rules_action_type_object_v2
+
+    out: AutomationRulesActionTypeListV2 = []
+    for item in data:
+        if item is None:
+            continue
+        out.append(
+            capo_securityhub.types.automation_rules_action_type_object_v2.deserialize_json(
+                item
+            )
+        )
+    return out

capo_securityhub/types/automation_rules_action_type_object_v2.py

@@ -0,0 +1,42 @@
+"""Generated from Smithy shape ``com.amazonaws.securityhub#AutomationRulesActionTypeObjectV2``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_securityhub.types.automation_rules_action_type_v2
+
+
+class AutomationRulesActionTypeObjectV2(TypedDict, closed=True):
+    type: NotRequired[
+        "capo_securityhub.types.automation_rules_action_type_v2.AutomationRulesActionTypeV2"
+    ]
+    """<p>The category of action to be executed by the automation rule.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: AutomationRulesActionTypeObjectV2) -> dict:
+    out: dict = {}
+    if "type" in value:
+        import capo_securityhub.types.automation_rules_action_type_v2
+
+        out["Type"] = (
+            capo_securityhub.types.automation_rules_action_type_v2.serialize_json(
+                value["type"]
+            )
+        )
+    return out
+
+
+def deserialize_json(data: dict) -> AutomationRulesActionTypeObjectV2:
+    out: AutomationRulesActionTypeObjectV2 = {}  # type: ignore[typeddict-item]
+    if data.get("Type") is not None:
+        import capo_securityhub.types.automation_rules_action_type_v2
+
+        out["type"] = (
+            capo_securityhub.types.automation_rules_action_type_v2.deserialize_json(
+                data["Type"]
+            )
+        )
+    return out

capo_securityhub/types/automation_rules_action_type_v2.py

@@ -0,0 +1,17 @@
+"""Generated from Smithy shape ``com.amazonaws.securityhub#AutomationRulesActionTypeV2``."""
+
+from typing import Literal, TypeAlias, cast
+
+AutomationRulesActionTypeV2: TypeAlias = Literal[
+    "FINDING_FIELDS_UPDATE",
+    "EXTERNAL_INTEGRATION",
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: AutomationRulesActionTypeV2) -> str:
+    return value
+
+
+def deserialize_json(data: str) -> AutomationRulesActionTypeV2:
+    return cast(AutomationRulesActionTypeV2, data)

capo_securityhub/types/automation_rules_action_v2.py

@@ -0,0 +1,84 @@
+"""Generated from Smithy shape ``com.amazonaws.securityhub#AutomationRulesActionV2``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_securityhub.types.automation_rules_action_type_v2
+    import capo_securityhub.types.automation_rules_finding_fields_update_v2
+    import capo_securityhub.types.external_integration_configuration
+
+
+class AutomationRulesActionV2(TypedDict, closed=True):
+    type: NotRequired[
+        "capo_securityhub.types.automation_rules_action_type_v2.AutomationRulesActionTypeV2"
+    ]
+    """<p>The category of action to be executed by the automation rule.</p>"""
+    finding_fields_update: NotRequired[
+        "capo_securityhub.types.automation_rules_finding_fields_update_v2.AutomationRulesFindingFieldsUpdateV2"
+    ]
+    """<p>The changes to be applied to fields in a security finding when an automation rule is triggered.</p>"""
+    external_integration_configuration: NotRequired[
+        "capo_securityhub.types.external_integration_configuration.ExternalIntegrationConfiguration"
+    ]
+    """<p>The settings for integrating automation rule actions with external systems or service.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: AutomationRulesActionV2) -> dict:
+    out: dict = {}
+    if "type" in value:
+        import capo_securityhub.types.automation_rules_action_type_v2
+
+        out["Type"] = (
+            capo_securityhub.types.automation_rules_action_type_v2.serialize_json(
+                value["type"]
+            )
+        )
+    if "finding_fields_update" in value:
+        import capo_securityhub.types.automation_rules_finding_fields_update_v2
+
+        out["FindingFieldsUpdate"] = (
+            capo_securityhub.types.automation_rules_finding_fields_update_v2.serialize_json(
+                value["finding_fields_update"]
+            )
+        )
+    if "external_integration_configuration" in value:
+        import capo_securityhub.types.external_integration_configuration
+
+        out["ExternalIntegrationConfiguration"] = (
+            capo_securityhub.types.external_integration_configuration.serialize_json(
+                value["external_integration_configuration"]
+            )
+        )
+    return out
+
+
+def deserialize_json(data: dict) -> AutomationRulesActionV2:
+    out: AutomationRulesActionV2 = {}  # type: ignore[typeddict-item]
+    if data.get("Type") is not None:
+        import capo_securityhub.types.automation_rules_action_type_v2
+
+        out["type"] = (
+            capo_securityhub.types.automation_rules_action_type_v2.deserialize_json(
+                data["Type"]
+            )
+        )
+    if data.get("FindingFieldsUpdate") is not None:
+        import capo_securityhub.types.automation_rules_finding_fields_update_v2
+
+        out["finding_fields_update"] = (
+            capo_securityhub.types.automation_rules_finding_fields_update_v2.deserialize_json(
+                data["FindingFieldsUpdate"]
+            )
+        )
+    if data.get("ExternalIntegrationConfiguration") is not None:
+        import capo_securityhub.types.external_integration_configuration
+
+        out["external_integration_configuration"] = (
+            capo_securityhub.types.external_integration_configuration.deserialize_json(
+                data["ExternalIntegrationConfiguration"]
+            )
+        )
+    return out

capo_securityhub/types/automation_rules_arns_list.py

@@ -0,0 +1,19 @@
+"""Generated from Smithy shape ``com.amazonaws.securityhub#AutomationRulesArnsList``."""
+
+from typing import TYPE_CHECKING, TypeAlias
+
+if TYPE_CHECKING:
+    import capo_securityhub.types.non_empty_string
+
+AutomationRulesArnsList: TypeAlias = list[
+    "capo_securityhub.types.non_empty_string.NonEmptyString"
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: AutomationRulesArnsList) -> list:
+    return list(value)
+
+
+def deserialize_json(data: list) -> AutomationRulesArnsList:
+    return [item for item in data if item is not None]

capo_securityhub/types/automation_rules_config.py

@@ -0,0 +1,140 @@
+"""Generated from Smithy shape ``com.amazonaws.securityhub#AutomationRulesConfig``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_securityhub.types.action_list
+    import capo_securityhub.types.automation_rules_finding_filters
+    import capo_securityhub.types.boolean
+    import capo_securityhub.types.non_empty_string
+    import capo_securityhub.types.rule_order_value
+    import capo_securityhub.types.rule_status
+    import capo_securityhub.types.timestamp
+
+
+class AutomationRulesConfig(TypedDict, closed=True):
+    rule_arn: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
+    """<p> The Amazon Resource Name (ARN) of a rule. </p>"""
+    rule_status: NotRequired["capo_securityhub.types.rule_status.RuleStatus"]
+    """<p> Whether the rule is active after it is created. If this parameter is equal to <code>ENABLED</code>, Security Hub CSPM starts applying the rule to findings and finding updates after the rule is created. </p>"""
+    rule_order: NotRequired["capo_securityhub.types.rule_order_value.RuleOrderValue"]
+    """<p> An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub CSPM applies rules with lower values for this parameter first. </p>"""
+    rule_name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
+    """<p> The name of the rule. </p>"""
+    description: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
+    """<p> A description of the rule. </p>"""
+    is_terminal: NotRequired["capo_securityhub.types.boolean.Boolean"]
+    """<p>Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub CSPM applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal. </p>"""
+    criteria: NotRequired[
+        "capo_securityhub.types.automation_rules_finding_filters.AutomationRulesFindingFilters"
+    ]
+    r"""<p> A set of <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html\">Amazon Web Services Security Finding Format</a> finding field attributes and corresponding expected values that Security Hub CSPM uses to filter findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub CSPM applies the rule action to the finding. </p>"""
+    actions: NotRequired["capo_securityhub.types.action_list.ActionList"]
+    """<p> One or more actions to update finding fields if a finding matches the defined criteria of the rule. </p>"""
+    created_at: NotRequired["capo_securityhub.types.timestamp.Timestamp"]
+    r"""<p> A timestamp that indicates when the rule was created. </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.timestamp.Timestamp"]
+    r"""<p> A timestamp that indicates when the rule was most recently updated. </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_by: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
+    """<p> The principal that created a rule. </p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: AutomationRulesConfig) -> dict:
+    out: dict = {}
+    if "rule_arn" in value:
+        out["RuleArn"] = value["rule_arn"]
+    if "rule_status" in value:
+        import capo_securityhub.types.rule_status
+
+        out["RuleStatus"] = capo_securityhub.types.rule_status.serialize_json(
+            value["rule_status"]
+        )
+    if "rule_order" in value:
+        out["RuleOrder"] = value["rule_order"]
+    if "rule_name" in value:
+        out["RuleName"] = value["rule_name"]
+    if "description" in value:
+        out["Description"] = value["description"]
+    if "is_terminal" in value:
+        out["IsTerminal"] = value["is_terminal"]
+    if "criteria" in value:
+        import capo_securityhub.types.automation_rules_finding_filters
+
+        out["Criteria"] = (
+            capo_securityhub.types.automation_rules_finding_filters.serialize_json(
+                value["criteria"]
+            )
+        )
+    if "actions" in value:
+        import capo_securityhub.types.action_list
+
+        out["Actions"] = capo_securityhub.types.action_list.serialize_json(
+            value["actions"]
+        )
+    if "created_at" in value:
+        import capo_securityhub.types.timestamp
+
+        out["CreatedAt"] = capo_securityhub.types.timestamp.serialize_json(
+            value["created_at"]
+        )
+    if "updated_at" in value:
+        import capo_securityhub.types.timestamp
+
+        out["UpdatedAt"] = capo_securityhub.types.timestamp.serialize_json(
+            value["updated_at"]
+        )
+    if "created_by" in value:
+        out["CreatedBy"] = value["created_by"]
+    return out
+
+
+def deserialize_json(data: dict) -> AutomationRulesConfig:
+    out: AutomationRulesConfig = {}  # type: ignore[typeddict-item]
+    if data.get("RuleArn") is not None:
+        out["rule_arn"] = data["RuleArn"]
+    if data.get("RuleStatus") is not None:
+        import capo_securityhub.types.rule_status
+
+        out["rule_status"] = capo_securityhub.types.rule_status.deserialize_json(
+            data["RuleStatus"]
+        )
+    if data.get("RuleOrder") is not None:
+        out["rule_order"] = data["RuleOrder"]
+    if data.get("RuleName") is not None:
+        out["rule_name"] = data["RuleName"]
+    if data.get("Description") is not None:
+        out["description"] = data["Description"]
+    if data.get("IsTerminal") is not None:
+        out["is_terminal"] = data["IsTerminal"]
+    if data.get("Criteria") is not None:
+        import capo_securityhub.types.automation_rules_finding_filters
+
+        out["criteria"] = (
+            capo_securityhub.types.automation_rules_finding_filters.deserialize_json(
+                data["Criteria"]
+            )
+        )
+    if data.get("Actions") is not None:
+        import capo_securityhub.types.action_list
+
+        out["actions"] = capo_securityhub.types.action_list.deserialize_json(
+            data["Actions"]
+        )
+    if data.get("CreatedAt") is not None:
+        import capo_securityhub.types.timestamp
+
+        out["created_at"] = capo_securityhub.types.timestamp.deserialize_json(
+            data["CreatedAt"]
+        )
+    if data.get("UpdatedAt") is not None:
+        import capo_securityhub.types.timestamp
+
+        out["updated_at"] = capo_securityhub.types.timestamp.deserialize_json(
+            data["UpdatedAt"]
+        )
+    if data.get("CreatedBy") is not None:
+        out["created_by"] = data["CreatedBy"]
+    return out

capo_securityhub/types/automation_rules_config_list.py

@@ -0,0 +1,33 @@
+"""Generated from Smithy shape ``com.amazonaws.securityhub#AutomationRulesConfigList``."""
+
+from typing import TYPE_CHECKING, TypeAlias
+
+if TYPE_CHECKING:
+    import capo_securityhub.types.automation_rules_config
+
+AutomationRulesConfigList: TypeAlias = list[
+    "capo_securityhub.types.automation_rules_config.AutomationRulesConfig"
+]
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: AutomationRulesConfigList) -> list:
+    import capo_securityhub.types.automation_rules_config
+
+    out: list = []
+    for item in value:
+        out.append(capo_securityhub.types.automation_rules_config.serialize_json(item))
+    return out
+
+
+def deserialize_json(data: list) -> AutomationRulesConfigList:
+    import capo_securityhub.types.automation_rules_config
+
+    out: AutomationRulesConfigList = []
+    for item in data:
+        if item is None:
+            continue
+        out.append(
+            capo_securityhub.types.automation_rules_config.deserialize_json(item)
+        )
+    return out

capo_securityhub/types/automation_rules_finding_fields_update.py

@@ -0,0 +1,140 @@
+"""Generated from Smithy shape ``com.amazonaws.securityhub#AutomationRulesFindingFieldsUpdate``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_securityhub.types.field_map
+    import capo_securityhub.types.note_update
+    import capo_securityhub.types.ratio_scale
+    import capo_securityhub.types.related_finding_list
+    import capo_securityhub.types.severity_update
+    import capo_securityhub.types.type_list
+    import capo_securityhub.types.verification_state
+    import capo_securityhub.types.workflow_update
+
+
+class AutomationRulesFindingFieldsUpdate(TypedDict, closed=True):
+    note: NotRequired["capo_securityhub.types.note_update.NoteUpdate"]
+    severity: NotRequired["capo_securityhub.types.severity_update.SeverityUpdate"]
+    verification_state: NotRequired[
+        "capo_securityhub.types.verification_state.VerificationState"
+    ]
+    """<p> The rule action updates the <code>VerificationState</code> field of a finding. </p>"""
+    confidence: NotRequired["capo_securityhub.types.ratio_scale.RatioScale"]
+    """<p> The rule action updates the <code>Confidence</code> field of a finding. </p>"""
+    criticality: NotRequired["capo_securityhub.types.ratio_scale.RatioScale"]
+    """<p> The rule action updates the <code>Criticality</code> field of a finding. </p>"""
+    types: NotRequired["capo_securityhub.types.type_list.TypeList"]
+    """<p> The rule action updates the <code>Types</code> field of a finding. </p>"""
+    user_defined_fields: NotRequired["capo_securityhub.types.field_map.FieldMap"]
+    """<p> The rule action updates the <code>UserDefinedFields</code> field of a finding. </p>"""
+    workflow: NotRequired["capo_securityhub.types.workflow_update.WorkflowUpdate"]
+    related_findings: NotRequired[
+        "capo_securityhub.types.related_finding_list.RelatedFindingList"
+    ]
+    """<p> The rule action updates the <code>RelatedFindings</code> field of a finding. </p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: AutomationRulesFindingFieldsUpdate) -> dict:
+    out: dict = {}
+    if "note" in value:
+        import capo_securityhub.types.note_update
+
+        out["Note"] = capo_securityhub.types.note_update.serialize_json(value["note"])
+    if "severity" in value:
+        import capo_securityhub.types.severity_update
+
+        out["Severity"] = capo_securityhub.types.severity_update.serialize_json(
+            value["severity"]
+        )
+    if "verification_state" in value:
+        import capo_securityhub.types.verification_state
+
+        out["VerificationState"] = (
+            capo_securityhub.types.verification_state.serialize_json(
+                value["verification_state"]
+            )
+        )
+    if "confidence" in value:
+        out["Confidence"] = value["confidence"]
+    if "criticality" in value:
+        out["Criticality"] = value["criticality"]
+    if "types" in value:
+        import capo_securityhub.types.type_list
+
+        out["Types"] = capo_securityhub.types.type_list.serialize_json(value["types"])
+    if "user_defined_fields" in value:
+        import capo_securityhub.types.field_map
+
+        out["UserDefinedFields"] = capo_securityhub.types.field_map.serialize_json(
+            value["user_defined_fields"]
+        )
+    if "workflow" in value:
+        import capo_securityhub.types.workflow_update
+
+        out["Workflow"] = capo_securityhub.types.workflow_update.serialize_json(
+            value["workflow"]
+        )
+    if "related_findings" in value:
+        import capo_securityhub.types.related_finding_list
+
+        out["RelatedFindings"] = (
+            capo_securityhub.types.related_finding_list.serialize_json(
+                value["related_findings"]
+            )
+        )
+    return out
+
+
+def deserialize_json(data: dict) -> AutomationRulesFindingFieldsUpdate:
+    out: AutomationRulesFindingFieldsUpdate = {}  # type: ignore[typeddict-item]
+    if data.get("Note") is not None:
+        import capo_securityhub.types.note_update
+
+        out["note"] = capo_securityhub.types.note_update.deserialize_json(data["Note"])
+    if data.get("Severity") is not None:
+        import capo_securityhub.types.severity_update
+
+        out["severity"] = capo_securityhub.types.severity_update.deserialize_json(
+            data["Severity"]
+        )
+    if data.get("VerificationState") is not None:
+        import capo_securityhub.types.verification_state
+
+        out["verification_state"] = (
+            capo_securityhub.types.verification_state.deserialize_json(
+                data["VerificationState"]
+            )
+        )
+    if data.get("Confidence") is not None:
+        out["confidence"] = data["Confidence"]
+    if data.get("Criticality") is not None:
+        out["criticality"] = data["Criticality"]
+    if data.get("Types") is not None:
+        import capo_securityhub.types.type_list
+
+        out["types"] = capo_securityhub.types.type_list.deserialize_json(data["Types"])
+    if data.get("UserDefinedFields") is not None:
+        import capo_securityhub.types.field_map
+
+        out["user_defined_fields"] = capo_securityhub.types.field_map.deserialize_json(
+            data["UserDefinedFields"]
+        )
+    if data.get("Workflow") is not None:
+        import capo_securityhub.types.workflow_update
+
+        out["workflow"] = capo_securityhub.types.workflow_update.deserialize_json(
+            data["Workflow"]
+        )
+    if data.get("RelatedFindings") is not None:
+        import capo_securityhub.types.related_finding_list
+
+        out["related_findings"] = (
+            capo_securityhub.types.related_finding_list.deserialize_json(
+                data["RelatedFindings"]
+            )
+        )
+    return out

capo_securityhub/types/automation_rules_finding_fields_update_v2.py

@@ -0,0 +1,41 @@
+"""Generated from Smithy shape ``com.amazonaws.securityhub#AutomationRulesFindingFieldsUpdateV2``."""
+
+from typing import TYPE_CHECKING
+
+from typing_extensions import NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    import capo_securityhub.types.integer
+    import capo_securityhub.types.non_empty_string
+
+
+class AutomationRulesFindingFieldsUpdateV2(TypedDict, closed=True):
+    severity_id: NotRequired["capo_securityhub.types.integer.Integer"]
+    """<p>The severity level to be assigned to findings that match the automation rule criteria.</p>"""
+    comment: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
+    """<p>Notes or contextual information for findings that are modified by the automation rule.</p>"""
+    status_id: NotRequired["capo_securityhub.types.integer.Integer"]
+    """<p>The status to be applied to findings that match automation rule criteria.</p>"""
+
+
+# --- restJson1 ser/de ---
+def serialize_json(value: AutomationRulesFindingFieldsUpdateV2) -> dict:
+    out: dict = {}
+    if "severity_id" in value:
+        out["SeverityId"] = value["severity_id"]
+    if "comment" in value:
+        out["Comment"] = value["comment"]
+    if "status_id" in value:
+        out["StatusId"] = value["status_id"]
+    return out
+
+
+def deserialize_json(data: dict) -> AutomationRulesFindingFieldsUpdateV2:
+    out: AutomationRulesFindingFieldsUpdateV2 = {}  # type: ignore[typeddict-item]
+    if data.get("SeverityId") is not None:
+        out["severity_id"] = data["SeverityId"]
+    if data.get("Comment") is not None:
+        out["comment"] = data["Comment"]
+    if data.get("StatusId") is not None:
+        out["status_id"] = data["StatusId"]
+    return out