Skip to content

Security Ir Classes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BatchGetMemberAccountDetailsRequest

membershipId

  • Type:
  • Required: Yes

accountIds

  • Type: typing.List[str]
  • Required: Yes

BatchGetMemberAccountDetailsResponse

items

  • Type: typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.GetMembershipAccountDetailItem]
  • Required: Yes

errors

  • Type: typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.GetMembershipAccountDetailError]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CancelMembershipRequest

membershipId

  • Type:
  • Required: Yes

CancelMembershipResponse

membershipId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CaseAttachmentAttributes

attachmentId

  • Type:
  • Required: Yes

fileName

  • Type:
  • Required: Yes

attachmentStatus

  • Type: typing.Literal['Failed', 'Pending', 'Verified']
  • Required: Yes

creator

  • Type:
  • Required: Yes

createdDate

  • Type:
  • Required: Yes

CaseEditItem

eventTimestamp

  • Type: typing.Optional[datetime.datetime]

principal

  • Type: typing.Optional[str]

action

  • Type: typing.Optional[str]

message

  • Type: typing.Optional[str]

CloseCaseRequest

caseId

  • Type:
  • Required: Yes

CloseCaseResponse

caseStatus

  • Type: typing.Literal['Acknowledged', 'Closed', 'Containment, Eradication and Recovery', 'Detection and Analysis', 'Post-incident Activities', 'Ready to Close', 'Submitted']
  • Required: Yes

closedDate

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateCaseCommentRequest

caseId

  • Type:
  • Required: Yes

body

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

CreateCaseCommentResponse

commentId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateCaseRequest

resolverType

  • Type: typing.Literal['AWS', 'Self']
  • Required: Yes

title

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

engagementType

  • Type: typing.Literal['Investigation', 'Security Incident']
  • Required: Yes

reportedIncidentStartDate

  • Type: typing.Union[datetime.datetime, str]
  • Required: Yes

impactedAccounts

  • Type: typing.List[str]
  • Required: Yes

watchers

  • Type: typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.Watcher]
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

threatActorIpAddresses

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.ThreatActorIp]]

impactedServices

  • Type: typing.Optional[typing.List[str]]

impactedAwsRegions

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.ImpactedAwsRegion]]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateCaseResponse

caseId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateMembershipRequest

membershipName

  • Type:
  • Required: Yes

incidentResponseTeam

  • Type: typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.IncidentResponder]
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

optInFeatures

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.OptInFeature]]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateMembershipResponse

membershipId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetCaseAttachmentDownloadUrlRequest

caseId

  • Type:
  • Required: Yes

attachmentId

  • Type:
  • Required: Yes

GetCaseAttachmentDownloadUrlResponse

attachmentPresignedUrl

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetCaseAttachmentUploadUrlRequest

caseId

  • Type:
  • Required: Yes

fileName

  • Type:
  • Required: Yes

contentLength

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

GetCaseAttachmentUploadUrlResponse

attachmentPresignedUrl

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetCaseRequest

caseId

  • Type:
  • Required: Yes

GetCaseResponse

title

  • Type:
  • Required: Yes

caseArn

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

caseStatus

  • Type: typing.Literal['Acknowledged', 'Closed', 'Containment, Eradication and Recovery', 'Detection and Analysis', 'Post-incident Activities', 'Ready to Close', 'Submitted']
  • Required: Yes

engagementType

  • Type: typing.Literal['Investigation', 'Security Incident']
  • Required: Yes

reportedIncidentStartDate

  • Type:
  • Required: Yes

actualIncidentStartDate

  • Type:
  • Required: Yes

impactedAwsRegions

  • Type: typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.ImpactedAwsRegion]
  • Required: Yes

threatActorIpAddresses

  • Type: typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.ThreatActorIp]
  • Required: Yes

pendingAction

  • Type: typing.Literal['Customer', 'None']
  • Required: Yes

impactedAccounts

  • Type: typing.List[str]
  • Required: Yes

watchers

  • Type: typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.Watcher]
  • Required: Yes

createdDate

  • Type:
  • Required: Yes

lastUpdatedDate

  • Type:
  • Required: Yes

closureCode

  • Type: typing.Literal['Duplicate', 'False Positive', 'Investigation Completed', 'Not Resolved']
  • Required: Yes

resolverType

  • Type: typing.Literal['AWS', 'Self']
  • Required: Yes

impactedServices

  • Type: typing.List[str]
  • Required: Yes

caseAttachments

  • Type: typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.CaseAttachmentAttributes]
  • Required: Yes

closedDate

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetMembershipAccountDetailError

accountId

  • Type:
  • Required: Yes

error

  • Type:
  • Required: Yes

message

  • Type:
  • Required: Yes

GetMembershipAccountDetailItem

accountId

  • Type: typing.Optional[str]

relationshipStatus

  • Type: typing.Optional[typing.Literal['Associated', 'Disassociated']]

relationshipType

  • Type: typing.Optional[typing.Literal['Organization']]

GetMembershipRequest

membershipId

  • Type:
  • Required: Yes

GetMembershipResponse

membershipId

  • Type:
  • Required: Yes

accountId

  • Type:
  • Required: Yes

region

  • Type: typing.Literal['af-south-1', 'ap-east-1', 'ap-northeast-1', 'ap-northeast-2', 'ap-northeast-3', 'ap-south-1', 'ap-south-2', 'ap-southeast-1', 'ap-southeast-2', 'ap-southeast-3', 'ap-southeast-4', 'ap-southeast-5', 'ca-central-1', 'ca-west-1', 'cn-north-1', 'cn-northwest-1', 'eu-central-1', 'eu-central-2', 'eu-north-1', 'eu-south-1', 'eu-south-2', 'eu-west-1', 'eu-west-2', 'eu-west-3', 'il-central-1', 'me-central-1', 'me-south-1', 'sa-east-1', 'us-east-1', 'us-east-2', 'us-west-1', 'us-west-2']
  • Required: Yes

membershipName

  • Type:
  • Required: Yes

membershipArn

  • Type:
  • Required: Yes

membershipStatus

  • Type: typing.Literal['Active', 'Cancelled', 'Terminated']
  • Required: Yes

membershipActivationTimestamp

  • Type:
  • Required: Yes

membershipDeactivationTimestamp

  • Type:
  • Required: Yes

customerType

  • Type: typing.Literal['Organization', 'Standalone']
  • Required: Yes

numberOfAccountsCovered

  • Type:
  • Required: Yes

incidentResponseTeam

  • Type: typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.IncidentResponder]
  • Required: Yes

optInFeatures

  • Type: typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.OptInFeature]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ImpactedAwsRegion

region

  • Type: typing.Literal['af-south-1', 'ap-east-1', 'ap-northeast-1', 'ap-northeast-2', 'ap-northeast-3', 'ap-south-1', 'ap-south-2', 'ap-southeast-1', 'ap-southeast-2', 'ap-southeast-3', 'ap-southeast-4', 'ap-southeast-5', 'ca-central-1', 'ca-west-1', 'cn-north-1', 'cn-northwest-1', 'eu-central-1', 'eu-central-2', 'eu-north-1', 'eu-south-1', 'eu-south-2', 'eu-west-1', 'eu-west-2', 'eu-west-3', 'il-central-1', 'me-central-1', 'me-south-1', 'sa-east-1', 'us-east-1', 'us-east-2', 'us-west-1', 'us-west-2']
  • Required: Yes

IncidentResponder

name

  • Type:
  • Required: Yes

jobTitle

  • Type:
  • Required: Yes

email

  • Type:
  • Required: Yes

ListCaseEditsRequest

caseId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListCaseEditsRequestPaginate

caseId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.PaginatorConfig]

ListCaseEditsResponse

items

  • Type: typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.CaseEditItem]
  • Required: Yes

total

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListCasesItem

caseId

  • Type:
  • Required: Yes

lastUpdatedDate

  • Type: typing.Optional[datetime.datetime]

title

  • Type: typing.Optional[str]

caseArn

  • Type: typing.Optional[str]

engagementType

  • Type: typing.Optional[typing.Literal['Investigation', 'Security Incident']]

caseStatus

  • Type: typing.Optional[typing.Literal['Acknowledged', 'Closed', 'Containment, Eradication and Recovery', 'Detection and Analysis', 'Post-incident Activities', 'Ready to Close', 'Submitted']]

createdDate

  • Type: typing.Optional[datetime.datetime]

closedDate

  • Type: typing.Optional[datetime.datetime]

resolverType

  • Type: typing.Optional[typing.Literal['AWS', 'Self']]

pendingAction

  • Type: typing.Optional[typing.Literal['Customer', 'None']]

ListCasesRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListCasesRequestPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.PaginatorConfig]

ListCasesResponse

items

  • Type: typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.ListCasesItem]
  • Required: Yes

total

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListCommentsItem

commentId

  • Type:
  • Required: Yes

createdDate

  • Type: typing.Optional[datetime.datetime]

lastUpdatedDate

  • Type: typing.Optional[datetime.datetime]

creator

  • Type: typing.Optional[str]

lastUpdatedBy

  • Type: typing.Optional[str]

body

  • Type: typing.Optional[str]

ListCommentsRequest

caseId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListCommentsRequestPaginate

caseId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.PaginatorConfig]

ListCommentsResponse

items

  • Type: typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.ListCommentsItem]
  • Required: Yes

total

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListMembershipItem

membershipId

  • Type:
  • Required: Yes

accountId

  • Type: typing.Optional[str]

region

  • Type: typing.Optional[typing.Literal['af-south-1', 'ap-east-1', 'ap-northeast-1', 'ap-northeast-2', 'ap-northeast-3', 'ap-south-1', 'ap-south-2', 'ap-southeast-1', 'ap-southeast-2', 'ap-southeast-3', 'ap-southeast-4', 'ap-southeast-5', 'ca-central-1', 'ca-west-1', 'cn-north-1', 'cn-northwest-1', 'eu-central-1', 'eu-central-2', 'eu-north-1', 'eu-south-1', 'eu-south-2', 'eu-west-1', 'eu-west-2', 'eu-west-3', 'il-central-1', 'me-central-1', 'me-south-1', 'sa-east-1', 'us-east-1', 'us-east-2', 'us-west-1', 'us-west-2']]

membershipArn

  • Type: typing.Optional[str]

membershipStatus

  • Type: typing.Optional[typing.Literal['Active', 'Cancelled', 'Terminated']]

ListMembershipsRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListMembershipsRequestPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.PaginatorConfig]

ListMembershipsResponse

items

  • Type: typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.ListMembershipItem]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTagsForResourceInput

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceOutput

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

OptInFeature

featureName

  • Type: typing.Literal['Triage']
  • Required: Yes

isEnabled

  • Type:
  • Required: Yes

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

TagResourceInput

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ThreatActorIp

ipAddress

  • Type:
  • Required: Yes

userAgent

  • Type: typing.Optional[str]

UntagResourceInput

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateCaseCommentRequest

caseId

  • Type:
  • Required: Yes

commentId

  • Type:
  • Required: Yes

body

  • Type:
  • Required: Yes

UpdateCaseCommentResponse

commentId

  • Type:
  • Required: Yes

body

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateCaseRequest

caseId

  • Type:
  • Required: Yes

title

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

reportedIncidentStartDate

  • Type: typing.Union[datetime.datetime, str, NoneType]

actualIncidentStartDate

  • Type: typing.Union[datetime.datetime, str, NoneType]

engagementType

  • Type: typing.Optional[typing.Literal['Investigation', 'Security Incident']]

watchersToAdd

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.Watcher]]

watchersToDelete

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.Watcher]]

threatActorIpAddressesToAdd

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.ThreatActorIp]]

threatActorIpAddressesToDelete

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.ThreatActorIp]]

impactedServicesToAdd

  • Type: typing.Optional[typing.List[str]]

impactedServicesToDelete

  • Type: typing.Optional[typing.List[str]]

impactedAwsRegionsToAdd

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.ImpactedAwsRegion]]

impactedAwsRegionsToDelete

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.ImpactedAwsRegion]]

impactedAccountsToAdd

  • Type: typing.Optional[typing.List[str]]

impactedAccountsToDelete

  • Type: typing.Optional[typing.List[str]]

UpdateCaseStatusRequest

caseId

  • Type:
  • Required: Yes

caseStatus

  • Type: typing.Literal['Containment, Eradication and Recovery', 'Detection and Analysis', 'Post-incident Activities', 'Submitted']
  • Required: Yes

UpdateCaseStatusResponse

caseStatus

  • Type: typing.Literal['Containment, Eradication and Recovery', 'Detection and Analysis', 'Post-incident Activities', 'Submitted']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateMembershipRequest

membershipId

  • Type:
  • Required: Yes

membershipName

  • Type: typing.Optional[str]

incidentResponseTeam

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.IncidentResponder]]

optInFeatures

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.security_ir.security_ir_classes.OptInFeature]]

UpdateResolverTypeRequest

caseId

  • Type:
  • Required: Yes

resolverType

  • Type: typing.Literal['AWS', 'Self']
  • Required: Yes

UpdateResolverTypeResponse

caseId

  • Type:
  • Required: Yes

caseStatus

  • Type: typing.Literal['Acknowledged', 'Closed', 'Containment, Eradication and Recovery', 'Detection and Analysis', 'Post-incident Activities', 'Ready to Close', 'Submitted']
  • Required: Yes

resolverType

  • Type: typing.Literal['AWS', 'Self']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Watcher

email

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

jobTitle

  • Type: typing.Optional[str]