Skip to content

UpdateCaseRequest

Source code in docs_src/capo_security_ir/types/update_case_request.py
class UpdateCaseRequest(TypedDict, closed=True):
    case_id: "capo_security_ir.types.case_id.CaseId"
    """<p>Required element for UpdateCase to identify the case ID for updates.</p>"""
    title: NotRequired["capo_security_ir.types.case_title.CaseTitle"]
    """<p>Optional element for UpdateCase to provide content for the title field.</p>"""
    description: NotRequired["capo_security_ir.types.case_description.CaseDescription"]
    """<p>Optional element for UpdateCase to provide content for the description field.</p>"""
    reported_incident_start_date: NotRequired["datetime.datetime"]
    """<p>Optional element for UpdateCase to provide content for the customer reported incident start date field. </p>"""
    actual_incident_start_date: NotRequired["datetime.datetime"]
    """<p>Optional element for UpdateCase to provide content for the incident start date field.</p>"""
    engagement_type: NotRequired[
        "capo_security_ir.types.engagement_type.EngagementType"
    ]
    """<p>Optional element for UpdateCase to provide content for the engagement type field. <code>Available engagement types include Security Incident | Investigation</code>. </p>"""
    watchers_to_add: NotRequired["capo_security_ir.types.watchers.Watchers"]
    """<p>Optional element for UpdateCase to provide content to add additional watchers to a case.</p>"""
    watchers_to_delete: NotRequired["capo_security_ir.types.watchers.Watchers"]
    """<p>Optional element for UpdateCase to provide content to remove existing watchers from a case.</p>"""
    threat_actor_ip_addresses_to_add: NotRequired[
        "capo_security_ir.types.threat_actor_ip_list.ThreatActorIpList"
    ]
    """<p>Optional element for UpdateCase to provide content to add additional suspicious IP addresses related to a case. </p>"""
    threat_actor_ip_addresses_to_delete: NotRequired[
        "capo_security_ir.types.threat_actor_ip_list.ThreatActorIpList"
    ]
    """<p>Optional element for UpdateCase to provide content to remove suspicious IP addresses from a case.</p>"""
    impacted_services_to_add: NotRequired[
        "capo_security_ir.types.impacted_services_list.ImpactedServicesList"
    ]
    """<p>Optional element for UpdateCase to provide content to add services impacted.</p>"""
    impacted_services_to_delete: NotRequired[
        "capo_security_ir.types.impacted_services_list.ImpactedServicesList"
    ]
    """<p>Optional element for UpdateCase to provide content to remove services impacted.</p>"""
    impacted_aws_regions_to_add: NotRequired[
        "capo_security_ir.types.impacted_aws_region_list.ImpactedAwsRegionList"
    ]
    """<p>Optional element for UpdateCase to provide content to add regions impacted.</p>"""
    impacted_aws_regions_to_delete: NotRequired[
        "capo_security_ir.types.impacted_aws_region_list.ImpactedAwsRegionList"
    ]
    """<p>Optional element for UpdateCase to provide content to remove regions impacted.</p>"""
    impacted_accounts_to_add: NotRequired[
        "capo_security_ir.types.impacted_accounts.ImpactedAccounts"
    ]
    """<p>Optional element for UpdateCase to provide content to add accounts impacted.</p> <note> <p> AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be <code>123123123</code> which is nine digits, and with zero-prepend would be <code>000123123123</code>. Not zero-prepending to 12 digits could result in errors. </p> </note>"""
    impacted_accounts_to_delete: NotRequired[
        "capo_security_ir.types.impacted_accounts.ImpactedAccounts"
    ]
    """<p>Optional element for UpdateCase to provide content to add accounts impacted.</p> <note> <p> AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be <code>123123123</code> which is nine digits, and with zero-prepend would be <code>000123123123</code>. Not zero-prepending to 12 digits could result in errors. </p> </note>"""
    case_metadata: NotRequired["capo_security_ir.types.case_metadata.CaseMetadata"]
    """<p>Update the case request with case metadata</p>"""

actual_incident_start_date instance-attribute

actual_incident_start_date: NotRequired[datetime]

Optional element for UpdateCase to provide content for the incident start date field.

case_id instance-attribute

case_id: CaseId

Required element for UpdateCase to identify the case ID for updates.

case_metadata instance-attribute

case_metadata: NotRequired[CaseMetadata]

Update the case request with case metadata

description instance-attribute

description: NotRequired[CaseDescription]

Optional element for UpdateCase to provide content for the description field.

engagement_type instance-attribute

engagement_type: NotRequired[EngagementType]

Optional element for UpdateCase to provide content for the engagement type field. Available engagement types include Security Incident | Investigation.

impacted_accounts_to_add instance-attribute

impacted_accounts_to_add: NotRequired[ImpactedAccounts]

Optional element for UpdateCase to provide content to add accounts impacted.

AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.

impacted_accounts_to_delete instance-attribute

impacted_accounts_to_delete: NotRequired[ImpactedAccounts]

Optional element for UpdateCase to provide content to add accounts impacted.

AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.

impacted_aws_regions_to_add instance-attribute

impacted_aws_regions_to_add: NotRequired[ImpactedAwsRegionList]

Optional element for UpdateCase to provide content to add regions impacted.

impacted_aws_regions_to_delete instance-attribute

impacted_aws_regions_to_delete: NotRequired[ImpactedAwsRegionList]

Optional element for UpdateCase to provide content to remove regions impacted.

impacted_services_to_add instance-attribute

impacted_services_to_add: NotRequired[ImpactedServicesList]

Optional element for UpdateCase to provide content to add services impacted.

impacted_services_to_delete instance-attribute

impacted_services_to_delete: NotRequired[ImpactedServicesList]

Optional element for UpdateCase to provide content to remove services impacted.

reported_incident_start_date instance-attribute

reported_incident_start_date: NotRequired[datetime]

Optional element for UpdateCase to provide content for the customer reported incident start date field.

threat_actor_ip_addresses_to_add instance-attribute

threat_actor_ip_addresses_to_add: NotRequired[ThreatActorIpList]

Optional element for UpdateCase to provide content to add additional suspicious IP addresses related to a case.

threat_actor_ip_addresses_to_delete instance-attribute

threat_actor_ip_addresses_to_delete: NotRequired[ThreatActorIpList]

Optional element for UpdateCase to provide content to remove suspicious IP addresses from a case.

title instance-attribute

title: NotRequired[CaseTitle]

Optional element for UpdateCase to provide content for the title field.

watchers_to_add instance-attribute

watchers_to_add: NotRequired[Watchers]

Optional element for UpdateCase to provide content to add additional watchers to a case.

watchers_to_delete instance-attribute

watchers_to_delete: NotRequired[Watchers]

Optional element for UpdateCase to provide content to remove existing watchers from a case.