View Source AWS.SecurityIR (aws-elixir v1.0.9)

This guide documents the action and response elements for use of the service.

Link to this section Summary

Functions

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

Returns the attributes of a case.

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

Returns the attributes of a membership.

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

Lists all cases the requester has access to.

Returns comments for a designated case.

Returns the memberships that the calling principal can access.

Returns currently configured tags on a resource.

Adds a tag(s) to a designated resource.

Removes a tag(s) from a designate resource.

Updates the state transitions for a designated cases.

Updates the resolver type for a case.

Link to this section Functions

Link to this function

batch_get_member_account_details(client, membership_id, input, options \\ [])

View Source

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

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.

Link to this function

cancel_membership(client, membership_id, input, options \\ [])

View Source

Cancels an existing membership.

Link to this function

close_case(client, case_id, input, options \\ [])

View Source

Closes an existing case.

Link to this function

create_case(client, input, options \\ [])

View Source

Creates a new case.

Link to this function

create_case_comment(client, case_id, input, options \\ [])

View Source

Adds a comment to an existing case.

Link to this function

create_membership(client, input, options \\ [])

View Source

Creates a new membership.

Link to this function

get_case(client, case_id, options \\ [])

View Source

Returns the attributes of a case.

Link to this function

get_case_attachment_download_url(client, attachment_id, case_id, options \\ [])

View Source

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

Link to this function

get_case_attachment_upload_url(client, case_id, input, options \\ [])

View Source

Uploads an attachment to a case.

Link to this function

get_membership(client, membership_id, options \\ [])

View Source

Returns the attributes of a membership.

Link to this function

list_case_edits(client, case_id, input, options \\ [])

View Source

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

Link to this function

list_cases(client, input, options \\ [])

View Source

Lists all cases the requester has access to.

Link to this function

list_comments(client, case_id, input, options \\ [])

View Source

Returns comments for a designated case.

Link to this function

list_memberships(client, input, options \\ [])

View Source

Returns the memberships that the calling principal can access.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Returns currently configured tags on a resource.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds a tag(s) to a designated resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes a tag(s) from a designate resource.

Link to this function

update_case(client, case_id, input, options \\ [])

View Source

Updates an existing case.

Link to this function

update_case_comment(client, case_id, comment_id, input, options \\ [])

View Source

Updates an existing case comment.

Link to this function

update_case_status(client, case_id, input, options \\ [])

View Source

Updates the state transitions for a designated cases.

Self-managed: the following states are available for self-managed cases.

  • Submitted → Detection and Analysis

  • Detection and Analysis → Containment, Eradication, and Recovery

  • Detection and Analysis → Post-incident Activities

  • Containment, Eradication, and Recovery → Detection and Analysis

  • Containment, Eradication, and Recovery → Post-incident Activities

  • Post-incident Activities → Containment, Eradication, and Recovery

  • Post-incident Activities → Detection and Analysis

  • Any → Closed

AWS supported: You must use the CloseCase API to close.

Link to this function

update_membership(client, membership_id, input, options \\ [])

View Source

Updates membership configuration.

Link to this function

update_resolver_type(client, case_id, input, options \\ [])

View Source

Updates the resolver type for a case.

This is a one-way action and cannot be reversed.