create_case
async
¶
create_case(
resolver_type: ResolverType,
title: CaseTitle,
description: CaseDescription,
engagement_type: EngagementType,
reported_incident_start_date: datetime,
impacted_accounts: ImpactedAccounts,
watchers: Watchers,
*,
config_overrides: Optional[AsyncSecurityIRClientConfig] = None,
client_token: Optional[str] = None,
threat_actor_ip_addresses: Optional[ThreatActorIpList] = None,
impacted_services: Optional[ImpactedServicesList] = None,
impacted_aws_regions: Optional[ImpactedAwsRegionList] = None,
tags: Optional[TagMap] = None,
) -> CreateCaseResponse
Creates a new case.
Parameters:
-
client_token(Optional[str], default:None) –The
clientTokenfield 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. -
resolver_type(ResolverType) –Required element used in combination with CreateCase to identify the resolver type.
-
title(CaseTitle) –Required element used in combination with CreateCase to provide a title for the new case.
-
description(CaseDescription) –Required element used in combination with CreateCase
to provide a description for the new case.
-
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
-
reported_incident_start_date(datetime) –Required element used in combination with CreateCase to provide an initial start date for the unauthorized activity.
-
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
123123123which is nine digits, and with zero-prepend would be000123123123. Not zero-prepending to 12 digits could result in errors. -
watchers(Watchers) –Required element used in combination with CreateCase to provide a list of entities to receive notifications for case updates.
-
threat_actor_ip_addresses(Optional[ThreatActorIpList], default:None) –An optional element used in combination with CreateCase to provide a list of suspicious internet protocol addresses associated with unauthorized activity.
-
impacted_services(Optional[ImpactedServicesList], default:None) –An optional element used in combination with CreateCase to provide a list of services impacted.
-
impacted_aws_regions(Optional[ImpactedAwsRegionList], default:None) –An optional element used in combination with CreateCase to provide a list of impacted regions.
-
tags(Optional[TagMap], default:None) –An optional element used in combination with CreateCase to add customer specified tags to a case.
Raises:
-
AccessDeniedException– -
ConflictException– -
InternalServerException– -
InvalidTokenException– -
ResourceNotFoundException– -
SecurityIncidentResponseNotActiveException– -
ServiceQuotaExceededException– -
ThrottlingException– -
ValidationException– -
UnknownServiceError–The service returned an error code this client does not model.
Examples:
Invoke CreateCase
>>> await client.create_case(resolver_type='Self', title='My sample case', description='Case description', reported_incident_start_date='2023-03-27T15:32:01.789Z', engagement_type='Investigation', watchers=[{'email': '[email protected]', 'name': 'Alice', 'jobTitle': 'CEO'}, {'email': '[email protected]', 'name': 'Bob', 'jobTitle': 'CFO'}], impacted_accounts=['000000000000', '111111111111'], impacted_services=['Amazon EC2', 'Amazon EKS'], impacted_aws_regions=[{'region': 'ap-southeast-1'}], threat_actor_ip_addresses=[{'ipAddress': '192.168.192.168', 'userAgent': 'Browser'}])
Source code in docs_src/capo_security_ir/_services/async_security_ir.py
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 | |