SecurityIncidentResponseClient

Index > SecurityIncidentResponse > SecurityIncidentResponseClient

Auto-generated documentation for SecurityIncidentResponse type annotations stubs module types-boto3-security-ir.

SecurityIncidentResponseClient

Type annotations and code completion for boto3.client("security-ir"). boto3 documentation

# SecurityIncidentResponseClient usage example

from boto3.session import Session
from types_boto3_security_ir.client import SecurityIncidentResponseClient

def get_security-ir_client() -> SecurityIncidentResponseClient:
    return Session().client("security-ir")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("security-ir").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("security-ir")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidTokenException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.SecurityIncidentResponseNotActiveException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_security_ir.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("security-ir").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("security-ir").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

batch_get_member_account_details

Provides information on whether the supplied account IDs are associated with a membership.

Type annotations and code completion for boto3.client("security-ir").batch_get_member_account_details method. boto3 documentation

# batch_get_member_account_details method definition

def batch_get_member_account_details(
    self,
    *,
    membershipId: str,
    accountIds: Sequence[str],
) -> BatchGetMemberAccountDetailsResponseTypeDef:  # (1)
    ...

1. See BatchGetMemberAccountDetailsResponseTypeDef

# batch_get_member_account_details method usage example with argument unpacking

kwargs: BatchGetMemberAccountDetailsRequestTypeDef = {  # (1)
    "membershipId": ...,
    "accountIds": ...,
}

parent.batch_get_member_account_details(**kwargs)

1. See BatchGetMemberAccountDetailsRequestTypeDef

cancel_membership

Cancels an existing membership.

Type annotations and code completion for boto3.client("security-ir").cancel_membership method. boto3 documentation

# cancel_membership method definition

def cancel_membership(
    self,
    *,
    membershipId: str,
) -> CancelMembershipResponseTypeDef:  # (1)
    ...

1. See CancelMembershipResponseTypeDef

# cancel_membership method usage example with argument unpacking

kwargs: CancelMembershipRequestTypeDef = {  # (1)
    "membershipId": ...,
}

parent.cancel_membership(**kwargs)

1. See CancelMembershipRequestTypeDef

close_case

Closes an existing case.

Type annotations and code completion for boto3.client("security-ir").close_case method. boto3 documentation

# close_case method definition

def close_case(
    self,
    *,
    caseId: str,
) -> CloseCaseResponseTypeDef:  # (1)
    ...

1. See CloseCaseResponseTypeDef

# close_case method usage example with argument unpacking

kwargs: CloseCaseRequestTypeDef = {  # (1)
    "caseId": ...,
}

parent.close_case(**kwargs)

1. See CloseCaseRequestTypeDef

create_case

Creates a new case.

Type annotations and code completion for boto3.client("security-ir").create_case method. boto3 documentation

# create_case method definition

def create_case(
    self,
    *,
    resolverType: ResolverTypeType,  # (1)
    title: str,
    description: str,
    engagementType: EngagementTypeType,  # (2)
    reportedIncidentStartDate: TimestampTypeDef,
    impactedAccounts: Sequence[str],
    watchers: Sequence[WatcherTypeDef],  # (3)
    clientToken: str = ...,
    threatActorIpAddresses: Sequence[ThreatActorIpTypeDef] = ...,  # (4)
    impactedServices: Sequence[str] = ...,
    impactedAwsRegions: Sequence[ImpactedAwsRegionTypeDef] = ...,  # (5)
    tags: Mapping[str, str] = ...,
) -> CreateCaseResponseTypeDef:  # (6)
    ...

1. See ResolverTypeType
2. See EngagementTypeType
3. See Sequence[WatcherTypeDef]
4. See Sequence[ThreatActorIpTypeDef]
5. See Sequence[ImpactedAwsRegionTypeDef]
6. See CreateCaseResponseTypeDef

# create_case method usage example with argument unpacking

kwargs: CreateCaseRequestTypeDef = {  # (1)
    "resolverType": ...,
    "title": ...,
    "description": ...,
    "engagementType": ...,
    "reportedIncidentStartDate": ...,
    "impactedAccounts": ...,
    "watchers": ...,
}

parent.create_case(**kwargs)

1. See CreateCaseRequestTypeDef

create_case_comment

Adds a comment to an existing case.

Type annotations and code completion for boto3.client("security-ir").create_case_comment method. boto3 documentation

# create_case_comment method definition

def create_case_comment(
    self,
    *,
    caseId: str,
    body: str,
    clientToken: str = ...,
) -> CreateCaseCommentResponseTypeDef:  # (1)
    ...

1. See CreateCaseCommentResponseTypeDef

# create_case_comment method usage example with argument unpacking

kwargs: CreateCaseCommentRequestTypeDef = {  # (1)
    "caseId": ...,
    "body": ...,
}

parent.create_case_comment(**kwargs)

1. See CreateCaseCommentRequestTypeDef

create_membership

Creates a new membership.

Type annotations and code completion for boto3.client("security-ir").create_membership method. boto3 documentation

# create_membership method definition

def create_membership(
    self,
    *,
    membershipName: str,
    incidentResponseTeam: Sequence[IncidentResponderTypeDef],  # (1)
    clientToken: str = ...,
    optInFeatures: Sequence[OptInFeatureTypeDef] = ...,  # (2)
    tags: Mapping[str, str] = ...,
    coverEntireOrganization: bool = ...,
) -> CreateMembershipResponseTypeDef:  # (3)
    ...

1. See Sequence[IncidentResponderTypeDef]
2. See Sequence[OptInFeatureTypeDef]
3. See CreateMembershipResponseTypeDef

# create_membership method usage example with argument unpacking

kwargs: CreateMembershipRequestTypeDef = {  # (1)
    "membershipName": ...,
    "incidentResponseTeam": ...,
}

parent.create_membership(**kwargs)

1. See CreateMembershipRequestTypeDef

get_case

Returns the attributes of a case.

Type annotations and code completion for boto3.client("security-ir").get_case method. boto3 documentation

# get_case method definition

def get_case(
    self,
    *,
    caseId: str,
) -> GetCaseResponseTypeDef:  # (1)
    ...

1. See GetCaseResponseTypeDef

# get_case method usage example with argument unpacking

kwargs: GetCaseRequestTypeDef = {  # (1)
    "caseId": ...,
}

parent.get_case(**kwargs)

1. See GetCaseRequestTypeDef

get_case_attachment_download_url

Returns a Pre-Signed URL for uploading attachments into a case.

Type annotations and code completion for boto3.client("security-ir").get_case_attachment_download_url method. boto3 documentation

# get_case_attachment_download_url method definition

def get_case_attachment_download_url(
    self,
    *,
    caseId: str,
    attachmentId: str,
) -> GetCaseAttachmentDownloadUrlResponseTypeDef:  # (1)
    ...

1. See GetCaseAttachmentDownloadUrlResponseTypeDef

# get_case_attachment_download_url method usage example with argument unpacking

kwargs: GetCaseAttachmentDownloadUrlRequestTypeDef = {  # (1)
    "caseId": ...,
    "attachmentId": ...,
}

parent.get_case_attachment_download_url(**kwargs)

1. See GetCaseAttachmentDownloadUrlRequestTypeDef

get_case_attachment_upload_url

Uploads an attachment to a case.

Type annotations and code completion for boto3.client("security-ir").get_case_attachment_upload_url method. boto3 documentation

# get_case_attachment_upload_url method definition

def get_case_attachment_upload_url(
    self,
    *,
    caseId: str,
    fileName: str,
    contentLength: int,
    clientToken: str = ...,
) -> GetCaseAttachmentUploadUrlResponseTypeDef:  # (1)
    ...

1. See GetCaseAttachmentUploadUrlResponseTypeDef

# get_case_attachment_upload_url method usage example with argument unpacking

kwargs: GetCaseAttachmentUploadUrlRequestTypeDef = {  # (1)
    "caseId": ...,
    "fileName": ...,
    "contentLength": ...,
}

parent.get_case_attachment_upload_url(**kwargs)

1. See GetCaseAttachmentUploadUrlRequestTypeDef

get_membership

Returns the attributes of a membership.

Type annotations and code completion for boto3.client("security-ir").get_membership method. boto3 documentation

# get_membership method definition

def get_membership(
    self,
    *,
    membershipId: str,
) -> GetMembershipResponseTypeDef:  # (1)
    ...

1. See GetMembershipResponseTypeDef

# get_membership method usage example with argument unpacking

kwargs: GetMembershipRequestTypeDef = {  # (1)
    "membershipId": ...,
}

parent.get_membership(**kwargs)

1. See GetMembershipRequestTypeDef

list_case_edits

Views the case history for edits made to a designated case.

Type annotations and code completion for boto3.client("security-ir").list_case_edits method. boto3 documentation

# list_case_edits method definition

def list_case_edits(
    self,
    *,
    caseId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListCaseEditsResponseTypeDef:  # (1)
    ...

1. See ListCaseEditsResponseTypeDef

# list_case_edits method usage example with argument unpacking

kwargs: ListCaseEditsRequestTypeDef = {  # (1)
    "caseId": ...,
}

parent.list_case_edits(**kwargs)

1. See ListCaseEditsRequestTypeDef

list_cases

Lists all cases the requester has access to.

Type annotations and code completion for boto3.client("security-ir").list_cases method. boto3 documentation

# list_cases method definition

def list_cases(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListCasesResponseTypeDef:  # (1)
    ...

1. See ListCasesResponseTypeDef

# list_cases method usage example with argument unpacking

kwargs: ListCasesRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_cases(**kwargs)

1. See ListCasesRequestTypeDef

list_comments

Returns comments for a designated case.

Type annotations and code completion for boto3.client("security-ir").list_comments method. boto3 documentation

# list_comments method definition

def list_comments(
    self,
    *,
    caseId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListCommentsResponseTypeDef:  # (1)
    ...

1. See ListCommentsResponseTypeDef

# list_comments method usage example with argument unpacking

kwargs: ListCommentsRequestTypeDef = {  # (1)
    "caseId": ...,
}

parent.list_comments(**kwargs)

1. See ListCommentsRequestTypeDef

list_memberships

Returns the memberships that the calling principal can access.

Type annotations and code completion for boto3.client("security-ir").list_memberships method. boto3 documentation

# list_memberships method definition

def list_memberships(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListMembershipsResponseTypeDef:  # (1)
    ...

1. See ListMembershipsResponseTypeDef

# list_memberships method usage example with argument unpacking

kwargs: ListMembershipsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_memberships(**kwargs)

1. See ListMembershipsRequestTypeDef

list_tags_for_resource

Returns currently configured tags on a resource.

Type annotations and code completion for boto3.client("security-ir").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...

1. See ListTagsForResourceOutputTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputTypeDef

tag_resource

Adds a tag(s) to a designated resource.

Type annotations and code completion for boto3.client("security-ir").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceInputTypeDef

untag_resource

Removes a tag(s) from a designate resource.

Type annotations and code completion for boto3.client("security-ir").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceInputTypeDef

update_case

Updates an existing case.

Type annotations and code completion for boto3.client("security-ir").update_case method. boto3 documentation

# update_case method definition

def update_case(
    self,
    *,
    caseId: str,
    title: str = ...,
    description: str = ...,
    reportedIncidentStartDate: TimestampTypeDef = ...,
    actualIncidentStartDate: TimestampTypeDef = ...,
    engagementType: EngagementTypeType = ...,  # (1)
    watchersToAdd: Sequence[WatcherTypeDef] = ...,  # (2)
    watchersToDelete: Sequence[WatcherTypeDef] = ...,  # (2)
    threatActorIpAddressesToAdd: Sequence[ThreatActorIpTypeDef] = ...,  # (4)
    threatActorIpAddressesToDelete: Sequence[ThreatActorIpTypeDef] = ...,  # (4)
    impactedServicesToAdd: Sequence[str] = ...,
    impactedServicesToDelete: Sequence[str] = ...,
    impactedAwsRegionsToAdd: Sequence[ImpactedAwsRegionTypeDef] = ...,  # (6)
    impactedAwsRegionsToDelete: Sequence[ImpactedAwsRegionTypeDef] = ...,  # (6)
    impactedAccountsToAdd: Sequence[str] = ...,
    impactedAccountsToDelete: Sequence[str] = ...,
) -> Dict[str, Any]:
    ...

1. See EngagementTypeType
2. See Sequence[WatcherTypeDef]
3. See Sequence[WatcherTypeDef]
4. See Sequence[ThreatActorIpTypeDef]
5. See Sequence[ThreatActorIpTypeDef]
6. See Sequence[ImpactedAwsRegionTypeDef]
7. See Sequence[ImpactedAwsRegionTypeDef]

# update_case method usage example with argument unpacking

kwargs: UpdateCaseRequestTypeDef = {  # (1)
    "caseId": ...,
}

parent.update_case(**kwargs)

1. See UpdateCaseRequestTypeDef

update_case_comment

Updates an existing case comment.

Type annotations and code completion for boto3.client("security-ir").update_case_comment method. boto3 documentation

# update_case_comment method definition

def update_case_comment(
    self,
    *,
    caseId: str,
    commentId: str,
    body: str,
) -> UpdateCaseCommentResponseTypeDef:  # (1)
    ...

1. See UpdateCaseCommentResponseTypeDef

# update_case_comment method usage example with argument unpacking

kwargs: UpdateCaseCommentRequestTypeDef = {  # (1)
    "caseId": ...,
    "commentId": ...,
    "body": ...,
}

parent.update_case_comment(**kwargs)

1. See UpdateCaseCommentRequestTypeDef

update_case_status

Updates the state transitions for a designated cases.

Type annotations and code completion for boto3.client("security-ir").update_case_status method. boto3 documentation

# update_case_status method definition

def update_case_status(
    self,
    *,
    caseId: str,
    caseStatus: SelfManagedCaseStatusType,  # (1)
) -> UpdateCaseStatusResponseTypeDef:  # (2)
    ...

1. See SelfManagedCaseStatusType
2. See UpdateCaseStatusResponseTypeDef

# update_case_status method usage example with argument unpacking

kwargs: UpdateCaseStatusRequestTypeDef = {  # (1)
    "caseId": ...,
    "caseStatus": ...,
}

parent.update_case_status(**kwargs)

1. See UpdateCaseStatusRequestTypeDef

update_membership

Updates membership configuration.

Type annotations and code completion for boto3.client("security-ir").update_membership method. boto3 documentation

# update_membership method definition

def update_membership(
    self,
    *,
    membershipId: str,
    membershipName: str = ...,
    incidentResponseTeam: Sequence[IncidentResponderTypeDef] = ...,  # (1)
    optInFeatures: Sequence[OptInFeatureTypeDef] = ...,  # (2)
    membershipAccountsConfigurationsUpdate: MembershipAccountsConfigurationsUpdateTypeDef = ...,  # (3)
    undoMembershipCancellation: bool = ...,
) -> Dict[str, Any]:
    ...

1. See Sequence[IncidentResponderTypeDef]
2. See Sequence[OptInFeatureTypeDef]
3. See MembershipAccountsConfigurationsUpdateTypeDef

# update_membership method usage example with argument unpacking

kwargs: UpdateMembershipRequestTypeDef = {  # (1)
    "membershipId": ...,
}

parent.update_membership(**kwargs)

1. See UpdateMembershipRequestTypeDef

update_resolver_type

Updates the resolver type for a case.

Type annotations and code completion for boto3.client("security-ir").update_resolver_type method. boto3 documentation

# update_resolver_type method definition

def update_resolver_type(
    self,
    *,
    caseId: str,
    resolverType: ResolverTypeType,  # (1)
) -> UpdateResolverTypeResponseTypeDef:  # (2)
    ...

1. See ResolverTypeType
2. See UpdateResolverTypeResponseTypeDef

# update_resolver_type method usage example with argument unpacking

kwargs: UpdateResolverTypeRequestTypeDef = {  # (1)
    "caseId": ...,
    "resolverType": ...,
}

parent.update_resolver_type(**kwargs)

1. See UpdateResolverTypeRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("security-ir").get_paginator method with overloads.

• client.get_paginator("list_case_edits") -> ListCaseEditsPaginator
• client.get_paginator("list_cases") -> ListCasesPaginator
• client.get_paginator("list_comments") -> ListCommentsPaginator
• client.get_paginator("list_memberships") -> ListMembershipsPaginator