securityir/aws.sdk.kotlin.services.securityir/SecurityIrClient

SecurityIrClient

interface SecurityIrClient : SdkClient

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

Types

class Builder : AbstractSdkClientBuilder<SecurityIrClient.Config, SecurityIrClient.Config.Builder, SecurityIrClient>

object Companion : AbstractAwsSdkClientFactory<SecurityIrClient.Config, SecurityIrClient.Config.Builder, SecurityIrClient, SecurityIrClient.Builder>

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig, TimeoutConfig

Properties

abstract override val config: SecurityIrClient.Config

SecurityIrClient's configuration

Functions

batchGetMemberAccountDetails

abstract suspend fun batchGetMemberAccountDetails(input: BatchGetMemberAccountDetailsRequest): BatchGetMemberAccountDetailsResponse

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

cancelMembership

abstract suspend fun cancelMembership(input: CancelMembershipRequest): CancelMembershipResponse

Cancels an existing membership.

abstract suspend fun closeCase(input: CloseCaseRequest): CloseCaseResponse

Closes an existing case.

abstract suspend fun createCase(input: CreateCaseRequest): CreateCaseResponse

Creates a new case.

createCaseComment

abstract suspend fun createCaseComment(input: CreateCaseCommentRequest): CreateCaseCommentResponse

Adds a comment to an existing case.

createMembership

abstract suspend fun createMembership(input: CreateMembershipRequest): CreateMembershipResponse

Creates a new membership.

abstract suspend fun getCase(input: GetCaseRequest): GetCaseResponse

Returns the attributes of a case.

getCaseAttachmentDownloadUrl

abstract suspend fun getCaseAttachmentDownloadUrl(input: GetCaseAttachmentDownloadUrlRequest): GetCaseAttachmentDownloadUrlResponse

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

getCaseAttachmentUploadUrl

abstract suspend fun getCaseAttachmentUploadUrl(input: GetCaseAttachmentUploadUrlRequest): GetCaseAttachmentUploadUrlResponse

Uploads an attachment to a case.

abstract suspend fun getMembership(input: GetMembershipRequest): GetMembershipResponse

Returns the attributes of a membership.

abstract suspend fun listCaseEdits(input: ListCaseEditsRequest): ListCaseEditsResponse

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

abstract suspend fun listCases(input: ListCasesRequest = ListCasesRequest { }): ListCasesResponse

Lists all cases the requester has access to.

abstract suspend fun listComments(input: ListCommentsRequest): ListCommentsResponse

Returns comments for a designated case.

listMemberships

abstract suspend fun listMemberships(input: ListMembershipsRequest = ListMembershipsRequest { }): ListMembershipsResponse

Returns the memberships that the calling principal can access.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Returns currently configured tags on a resource.

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds a tag(s) to a designated resource.

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes a tag(s) from a designate resource.

abstract suspend fun updateCase(input: UpdateCaseRequest): UpdateCaseResponse

Updates an existing case.

updateCaseComment

abstract suspend fun updateCaseComment(input: UpdateCaseCommentRequest): UpdateCaseCommentResponse

Updates an existing case comment.

updateCaseStatus

abstract suspend fun updateCaseStatus(input: UpdateCaseStatusRequest): UpdateCaseStatusResponse

Updates the state transitions for a designated cases.

updateMembership

abstract suspend fun updateMembership(input: UpdateMembershipRequest): UpdateMembershipResponse

Updates membership configuration.

updateResolverType

abstract suspend fun updateResolverType(input: UpdateResolverTypeRequest): UpdateResolverTypeResponse

Updates the resolver type for a case.

Inherited functions

batchGetMemberAccountDetails

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

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

cancelMembership

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

Cancels an existing membership.

expect abstract fun close()

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

Closes an existing case.

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

Creates a new case.

createCaseComment

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

Adds a comment to an existing case.

createMembership

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

Creates a new membership.

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

Returns the attributes of a case.

getCaseAttachmentDownloadUrl

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

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

getCaseAttachmentUploadUrl

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

Uploads an attachment to a case.

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

Returns the attributes of a membership.

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

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

listCaseEditsPaginated

fun SecurityIrClient.listCaseEditsPaginated(initialRequest: ListCaseEditsRequest): Flow<ListCaseEditsResponse>

fun SecurityIrClient.listCaseEditsPaginated(block: ListCaseEditsRequest.Builder.() -> Unit): Flow<ListCaseEditsResponse>

Paginate over ListCaseEditsResponse results.

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

Lists all cases the requester has access to.

listCasesPaginated

fun SecurityIrClient.listCasesPaginated(initialRequest: ListCasesRequest = ListCasesRequest { }): Flow<ListCasesResponse>

fun SecurityIrClient.listCasesPaginated(block: ListCasesRequest.Builder.() -> Unit): Flow<ListCasesResponse>

Paginate over ListCasesResponse results.

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

Returns comments for a designated case.

listCommentsPaginated

fun SecurityIrClient.listCommentsPaginated(initialRequest: ListCommentsRequest): Flow<ListCommentsResponse>

fun SecurityIrClient.listCommentsPaginated(block: ListCommentsRequest.Builder.() -> Unit): Flow<ListCommentsResponse>

Paginate over ListCommentsResponse results.

listMemberships

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

Returns the memberships that the calling principal can access.

listMembershipsPaginated

fun SecurityIrClient.listMembershipsPaginated(initialRequest: ListMembershipsRequest = ListMembershipsRequest { }): Flow<ListMembershipsResponse>

fun SecurityIrClient.listMembershipsPaginated(block: ListMembershipsRequest.Builder.() -> Unit): Flow<ListMembershipsResponse>

Paginate over ListMembershipsResponse results.

listTagsForResource

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

Returns currently configured tags on a resource.

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

Adds a tag(s) to a designated resource.

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

Removes a tag(s) from a designate resource.

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

Updates an existing case.

updateCaseComment

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

Updates an existing case comment.

updateCaseStatus

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

Updates the state transitions for a designated cases.

updateMembership

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

Updates membership configuration.

updateResolverType

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

Updates 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.