Skip to content

CreateCaseRequest

Source code in docs_src/capo_security_ir/types/create_case_request.py
class CreateCaseRequest(TypedDict, closed=True):
    client_token: NotRequired["str"]
    """<note> <p>The <code>clientToken</code> field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided. </p> </note>"""
    resolver_type: "capo_security_ir.types.resolver_type.ResolverType"
    """<p>Required element used in combination with CreateCase to identify the resolver type.</p>"""
    title: "capo_security_ir.types.case_title.CaseTitle"
    """<p>Required element used in combination with CreateCase to provide a title for the new case.</p>"""
    description: "capo_security_ir.types.case_description.CaseDescription"
    """<p>Required element used in combination with CreateCase</p> <p>to provide a description for the new case.</p>"""
    engagement_type: "capo_security_ir.types.engagement_type.EngagementType"
    """<p>Required element used in combination with CreateCase to provide an engagement type for the new cases. Available engagement types include Security Incident | Investigation </p>"""
    reported_incident_start_date: "datetime.datetime"
    """<p>Required element used in combination with CreateCase to provide an initial start date for the unauthorized activity. </p>"""
    impacted_accounts: "capo_security_ir.types.impacted_accounts.ImpactedAccounts"
    """<p>Required element used in combination with CreateCase to provide a list of impacted accounts.</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>"""
    watchers: "capo_security_ir.types.watchers.Watchers"
    """<p>Required element used in combination with CreateCase to provide a list of entities to receive notifications for case updates. </p>"""
    threat_actor_ip_addresses: NotRequired[
        "capo_security_ir.types.threat_actor_ip_list.ThreatActorIpList"
    ]
    """<p>An optional element used in combination with CreateCase to provide a list of suspicious internet protocol addresses associated with unauthorized activity. </p>"""
    impacted_services: NotRequired[
        "capo_security_ir.types.impacted_services_list.ImpactedServicesList"
    ]
    """<p>An optional element used in combination with CreateCase to provide a list of services impacted.</p>"""
    impacted_aws_regions: NotRequired[
        "capo_security_ir.types.impacted_aws_region_list.ImpactedAwsRegionList"
    ]
    """<p>An optional element used in combination with CreateCase to provide a list of impacted regions.</p>"""
    tags: NotRequired["capo_security_ir.types.tag_map.TagMap"]
    """<p>An optional element used in combination with CreateCase to add customer specified tags to a case.</p>"""

client_token instance-attribute

client_token: NotRequired[str]

The clientToken field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided.

description instance-attribute

description: CaseDescription

Required element used in combination with CreateCase

to provide a description for the new case.

engagement_type instance-attribute

engagement_type: EngagementType

Required element used in combination with CreateCase to provide an engagement type for the new cases. Available engagement types include Security Incident | Investigation

impacted_accounts instance-attribute

impacted_accounts: ImpactedAccounts

Required element used in combination with CreateCase to provide a list of impacted accounts.

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 instance-attribute

impacted_aws_regions: NotRequired[ImpactedAwsRegionList]

An optional element used in combination with CreateCase to provide a list of impacted regions.

impacted_services instance-attribute

impacted_services: NotRequired[ImpactedServicesList]

An optional element used in combination with CreateCase to provide a list of services impacted.

reported_incident_start_date instance-attribute

reported_incident_start_date: datetime

Required element used in combination with CreateCase to provide an initial start date for the unauthorized activity.

resolver_type instance-attribute

resolver_type: ResolverType

Required element used in combination with CreateCase to identify the resolver type.

tags instance-attribute

tags: NotRequired[TagMap]

An optional element used in combination with CreateCase to add customer specified tags to a case.

threat_actor_ip_addresses instance-attribute

threat_actor_ip_addresses: NotRequired[ThreatActorIpList]

An optional element used in combination with CreateCase to provide a list of suspicious internet protocol addresses associated with unauthorized activity.

title instance-attribute

title: CaseTitle

Required element used in combination with CreateCase to provide a title for the new case.

watchers instance-attribute

watchers: Watchers

Required element used in combination with CreateCase to provide a list of entities to receive notifications for case updates.