aiops/aws.sdk.kotlin.services.aiops/AiOpsClient

AiOpsClient

The CloudWatch investigations feature is a generative AI-powered assistant that can help you respond to incidents in your system. It uses generative AI to scan your system's telemetry and quickly surface suggestions that might be related to your issue. These suggestions include metrics, logs, deployment events, and root-cause hypotheses.

You can use API actions to create, manage, and delete investigation groups and investigation group policies. To start and manage investigations, you must use the CloudWatch console.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: AiOpsClient.Config

AiOpsClient's configuration

Functions

createInvestigationGroup

abstract suspend fun createInvestigationGroup(input: CreateInvestigationGroupRequest): CreateInvestigationGroupResponse

Creates an investigation group in your account. Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary task to be able to perform investigations.

deleteInvestigationGroup

abstract suspend fun deleteInvestigationGroup(input: DeleteInvestigationGroupRequest): DeleteInvestigationGroupResponse

Deletes the specified investigation group from your account. You can currently have one investigation group per Region in your account. After you delete an investigation group, you can later create a new investigation group in the same Region.

deleteInvestigationGroupPolicy

abstract suspend fun deleteInvestigationGroupPolicy(input: DeleteInvestigationGroupPolicyRequest): DeleteInvestigationGroupPolicyResponse

Removes the IAM resource policy from being associated with the investigation group that you specify.

getInvestigationGroup

abstract suspend fun getInvestigationGroup(input: GetInvestigationGroupRequest): GetInvestigationGroupResponse

Returns the configuration information for the specified investigation group.

getInvestigationGroupPolicy

abstract suspend fun getInvestigationGroupPolicy(input: GetInvestigationGroupPolicyRequest): GetInvestigationGroupPolicyResponse

Returns the IAM resource policy that is associated with the specified investigation group.

listInvestigationGroups

abstract suspend fun listInvestigationGroups(input: ListInvestigationGroupsRequest = ListInvestigationGroupsRequest { }): ListInvestigationGroupsResponse

Returns the ARN and name of each investigation group in the account.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Displays the tags associated with a CloudWatch investigations resource. Currently, investigation groups support tagging.

putInvestigationGroupPolicy

abstract suspend fun putInvestigationGroupPolicy(input: PutInvestigationGroupPolicyRequest): PutInvestigationGroupPolicyResponse

Creates an IAM resource policy and assigns it to the specified investigation group.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Assigns one or more tags (key-value pairs) to the specified resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes one or more tags from the specified resource.

updateInvestigationGroup

abstract suspend fun updateInvestigationGroup(input: UpdateInvestigationGroupRequest): UpdateInvestigationGroupResponse

Updates the configuration of the specified investigation group.

Inherited functions

expect abstract fun close()

createInvestigationGroup

inline suspend fun AiOpsClient.createInvestigationGroup(crossinline block: CreateInvestigationGroupRequest.Builder.() -> Unit): CreateInvestigationGroupResponse

deleteInvestigationGroup

inline suspend fun AiOpsClient.deleteInvestigationGroup(crossinline block: DeleteInvestigationGroupRequest.Builder.() -> Unit): DeleteInvestigationGroupResponse

deleteInvestigationGroupPolicy

inline suspend fun AiOpsClient.deleteInvestigationGroupPolicy(crossinline block: DeleteInvestigationGroupPolicyRequest.Builder.() -> Unit): DeleteInvestigationGroupPolicyResponse

Removes the IAM resource policy from being associated with the investigation group that you specify.

getInvestigationGroup

inline suspend fun AiOpsClient.getInvestigationGroup(crossinline block: GetInvestigationGroupRequest.Builder.() -> Unit): GetInvestigationGroupResponse

Returns the configuration information for the specified investigation group.

getInvestigationGroupPolicy

inline suspend fun AiOpsClient.getInvestigationGroupPolicy(crossinline block: GetInvestigationGroupPolicyRequest.Builder.() -> Unit): GetInvestigationGroupPolicyResponse

Returns the IAM resource policy that is associated with the specified investigation group.

listInvestigationGroups

inline suspend fun AiOpsClient.listInvestigationGroups(crossinline block: ListInvestigationGroupsRequest.Builder.() -> Unit): ListInvestigationGroupsResponse

Returns the ARN and name of each investigation group in the account.

listInvestigationGroupsPaginated

fun AiOpsClient.listInvestigationGroupsPaginated(initialRequest: ListInvestigationGroupsRequest = ListInvestigationGroupsRequest { }): Flow<ListInvestigationGroupsResponse>

fun AiOpsClient.listInvestigationGroupsPaginated(block: ListInvestigationGroupsRequest.Builder.() -> Unit): Flow<ListInvestigationGroupsResponse>

Paginate over ListInvestigationGroupsResponse results.

listTagsForResource

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

Displays the tags associated with a CloudWatch investigations resource. Currently, investigation groups support tagging.

putInvestigationGroupPolicy

inline suspend fun AiOpsClient.putInvestigationGroupPolicy(crossinline block: PutInvestigationGroupPolicyRequest.Builder.() -> Unit): PutInvestigationGroupPolicyResponse

Creates an IAM resource policy and assigns it to the specified investigation group.

tagResource

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

Assigns one or more tags (key-value pairs) to the specified resource.

untagResource

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

Removes one or more tags from the specified resource.

updateInvestigationGroup

inline suspend fun AiOpsClient.updateInvestigationGroup(crossinline block: UpdateInvestigationGroupRequest.Builder.() -> Unit): UpdateInvestigationGroupResponse

Updates the configuration of the specified investigation group.

withConfig

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

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.