securityir/aws.sdk.kotlin.services.securityir

Package-level declarations

Types

SecurityIrClient

interface SecurityIrClient : SdkClient

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

Properties

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

const val ServiceId: String

Inherited functions

batchGetMemberAccountDetails

inline suspend fun SecurityIrClient.batchGetMemberAccountDetails(crossinline block: BatchGetMemberAccountDetailsRequest.Builder.() -> Unit): BatchGetMemberAccountDetailsResponse

Grants permission to view an existing membership.

cancelMembership

inline suspend fun SecurityIrClient.cancelMembership(crossinline block: CancelMembershipRequest.Builder.() -> Unit): CancelMembershipResponse

Grants permissions to cancel an existing membership.

inline suspend fun SecurityIrClient.closeCase(crossinline block: CloseCaseRequest.Builder.() -> Unit): CloseCaseResponse

Grants permission to close an existing case.

inline suspend fun SecurityIrClient.createCase(crossinline block: CreateCaseRequest.Builder.() -> Unit): CreateCaseResponse

Grants permission to create a new case.

createCaseComment

inline suspend fun SecurityIrClient.createCaseComment(crossinline block: CreateCaseCommentRequest.Builder.() -> Unit): CreateCaseCommentResponse

Grants permission to add a comment to an existing case.

createMembership

inline suspend fun SecurityIrClient.createMembership(crossinline block: CreateMembershipRequest.Builder.() -> Unit): CreateMembershipResponse

Grants permissions to create a new membership.

inline suspend fun SecurityIrClient.getCase(crossinline block: GetCaseRequest.Builder.() -> Unit): GetCaseResponse

Grant permission to view a designated case.

getCaseAttachmentDownloadUrl

inline suspend fun SecurityIrClient.getCaseAttachmentDownloadUrl(crossinline block: GetCaseAttachmentDownloadUrlRequest.Builder.() -> Unit): GetCaseAttachmentDownloadUrlResponse

Grants permission to obtain an Amazon S3 presigned URL to download an attachment.

getCaseAttachmentUploadUrl

inline suspend fun SecurityIrClient.getCaseAttachmentUploadUrl(crossinline block: GetCaseAttachmentUploadUrlRequest.Builder.() -> Unit): GetCaseAttachmentUploadUrlResponse

Grants permission to upload an attachment to a case.

inline suspend fun SecurityIrClient.getMembership(crossinline block: GetMembershipRequest.Builder.() -> Unit): GetMembershipResponse

Grants permission to get details of a designated service membership.

inline suspend fun SecurityIrClient.listCaseEdits(crossinline block: ListCaseEditsRequest.Builder.() -> Unit): ListCaseEditsResponse

Grants permissions to view the aidt log for edits made to a designated case.

inline suspend fun SecurityIrClient.listCases(crossinline block: ListCasesRequest.Builder.() -> Unit): ListCasesResponse

Grants permission to list all cases the requester has access to.

inline suspend fun SecurityIrClient.listComments(crossinline block: ListCommentsRequest.Builder.() -> Unit): ListCommentsResponse

Grants permissions to list and view comments for a designated case.

listMemberships

inline suspend fun SecurityIrClient.listMemberships(crossinline block: ListMembershipsRequest.Builder.() -> Unit): ListMembershipsResponse

Grants permission to query the memberships a principal has access to.

listTagsForResource

inline suspend fun SecurityIrClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Grants permission to view currently configured tags on a resource.

inline suspend fun SecurityIrClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Grants permission to add a tag(s) to a designated resource.

inline suspend fun SecurityIrClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Grants permission to remove a tag(s) from a designate resource.

inline suspend fun SecurityIrClient.updateCase(crossinline block: UpdateCaseRequest.Builder.() -> Unit): UpdateCaseResponse

Grants permission to update an existing case.

updateCaseComment

inline suspend fun SecurityIrClient.updateCaseComment(crossinline block: UpdateCaseCommentRequest.Builder.() -> Unit): UpdateCaseCommentResponse

Grants permission to update an existing case comment.

updateCaseStatus

inline suspend fun SecurityIrClient.updateCaseStatus(crossinline block: UpdateCaseStatusRequest.Builder.() -> Unit): UpdateCaseStatusResponse

Grants permission to update the status for a designated cases. Options include Submitted | Detection and Analysis | Eradication, Containment and Recovery | Post-Incident Activities | Closed.

updateMembership

inline suspend fun SecurityIrClient.updateMembership(crossinline block: UpdateMembershipRequest.Builder.() -> Unit): UpdateMembershipResponse

Grants access to UpdateMembership to change membership configuration.

updateResolverType

inline suspend fun SecurityIrClient.updateResolverType(crossinline block: UpdateResolverTypeRequest.Builder.() -> Unit): UpdateResolverTypeResponse

Grants permission to update the resolver type for a case.

fun SecurityIrClient.withConfig(block: SecurityIrClient.Config.Builder.() -> Unit): SecurityIrClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.