Interface AiOpsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface AiOpsClient
extends AwsClient

Service client for accessing AWS AI Ops. This can be created using the static builder() method.

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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static AiOpsClientBuilder	builder()	Create a builder that can be used to configure and create a AiOpsClient.
static AiOpsClient	create()	Create a AiOpsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateInvestigationGroupResponse	createInvestigationGroup(Consumer<CreateInvestigationGroupRequest.Builder> createInvestigationGroupRequest)	Creates an investigation group in your account.
default CreateInvestigationGroupResponse	createInvestigationGroup(CreateInvestigationGroupRequest createInvestigationGroupRequest)	Creates an investigation group in your account.
default DeleteInvestigationGroupResponse	deleteInvestigationGroup(Consumer<DeleteInvestigationGroupRequest.Builder> deleteInvestigationGroupRequest)	Deletes the specified investigation group from your account.
default DeleteInvestigationGroupResponse	deleteInvestigationGroup(DeleteInvestigationGroupRequest deleteInvestigationGroupRequest)	Deletes the specified investigation group from your account.
default DeleteInvestigationGroupPolicyResponse	deleteInvestigationGroupPolicy(Consumer<DeleteInvestigationGroupPolicyRequest.Builder> deleteInvestigationGroupPolicyRequest)	Removes the IAM resource policy from being associated with the investigation group that you specify.
default DeleteInvestigationGroupPolicyResponse	deleteInvestigationGroupPolicy(DeleteInvestigationGroupPolicyRequest deleteInvestigationGroupPolicyRequest)	Removes the IAM resource policy from being associated with the investigation group that you specify.
default GetInvestigationGroupResponse	getInvestigationGroup(Consumer<GetInvestigationGroupRequest.Builder> getInvestigationGroupRequest)	Returns the configuration information for the specified investigation group.
default GetInvestigationGroupResponse	getInvestigationGroup(GetInvestigationGroupRequest getInvestigationGroupRequest)	Returns the configuration information for the specified investigation group.
default GetInvestigationGroupPolicyResponse	getInvestigationGroupPolicy(Consumer<GetInvestigationGroupPolicyRequest.Builder> getInvestigationGroupPolicyRequest)	Returns the JSON of the IAM resource policy associated with the specified investigation group in a string.
default GetInvestigationGroupPolicyResponse	getInvestigationGroupPolicy(GetInvestigationGroupPolicyRequest getInvestigationGroupPolicyRequest)	Returns the JSON of the IAM resource policy associated with the specified investigation group in a string.
default ListInvestigationGroupsResponse	listInvestigationGroups(Consumer<ListInvestigationGroupsRequest.Builder> listInvestigationGroupsRequest)	Returns the ARN and name of each investigation group in the account.
default ListInvestigationGroupsResponse	listInvestigationGroups(ListInvestigationGroupsRequest listInvestigationGroupsRequest)	Returns the ARN and name of each investigation group in the account.
default ListInvestigationGroupsIterable	listInvestigationGroupsPaginator(Consumer<ListInvestigationGroupsRequest.Builder> listInvestigationGroupsRequest)	This is a variant of listInvestigationGroups(software.amazon.awssdk.services.aiops.model.ListInvestigationGroupsRequest) operation.
default ListInvestigationGroupsIterable	listInvestigationGroupsPaginator(ListInvestigationGroupsRequest listInvestigationGroupsRequest)	This is a variant of listInvestigationGroups(software.amazon.awssdk.services.aiops.model.ListInvestigationGroupsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Displays the tags associated with a CloudWatch investigations resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Displays the tags associated with a CloudWatch investigations resource.
default PutInvestigationGroupPolicyResponse	putInvestigationGroupPolicy(Consumer<PutInvestigationGroupPolicyRequest.Builder> putInvestigationGroupPolicyRequest)	Creates an IAM resource policy and assigns it to the specified investigation group.
default PutInvestigationGroupPolicyResponse	putInvestigationGroupPolicy(PutInvestigationGroupPolicyRequest putInvestigationGroupPolicyRequest)	Creates an IAM resource policy and assigns it to the specified investigation group.
default AiOpsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Assigns one or more tags (key-value pairs) to the specified resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Assigns one or more tags (key-value pairs) to the specified resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes one or more tags from the specified resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes one or more tags from the specified resource.
default UpdateInvestigationGroupResponse	updateInvestigationGroup(Consumer<UpdateInvestigationGroupRequest.Builder> updateInvestigationGroupRequest)	Updates the configuration of the specified investigation group.
default UpdateInvestigationGroupResponse	updateInvestigationGroup(UpdateInvestigationGroupRequest updateInvestigationGroupRequest)	Updates the configuration of the specified investigation group.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createInvestigationGroup

default CreateInvestigationGroupResponse createInvestigationGroup(CreateInvestigationGroupRequest createInvestigationGroupRequest)
                                                           throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

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.

Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:

• Who can access the investigations

• Whether investigation data is encrypted with a customer managed Key Management Service key.

• How long investigations and their data are retained by default.

Currently, you can have one investigation group in each Region in your account. Each investigation in a Region is a part of the investigation group in that Region

To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has either the AIOpsConsoleAdminPolicy or the AdministratorAccess IAM policy attached, or to an account that has similar permissions.

You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with CreateInvestigationGroup and you want to enable alarms to do this, you must use PutInvestigationGroupPolicy to create a resource policy that grants this permission to CloudWatch alarms.

For more information about configuring CloudWatch alarms, see Using Amazon CloudWatch alarms

Parameters:

createInvestigationGroupRequest -

Returns:

Result of the CreateInvestigationGroup operation returned by the service.

See Also:

• AWS API Documentation

createInvestigationGroup

default CreateInvestigationGroupResponse createInvestigationGroup(Consumer<CreateInvestigationGroupRequest.Builder> createInvestigationGroupRequest)
                                                           throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

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.

Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:

• Who can access the investigations

• Whether investigation data is encrypted with a customer managed Key Management Service key.

• How long investigations and their data are retained by default.

Currently, you can have one investigation group in each Region in your account. Each investigation in a Region is a part of the investigation group in that Region

To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has either the AIOpsConsoleAdminPolicy or the AdministratorAccess IAM policy attached, or to an account that has similar permissions.

You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with CreateInvestigationGroup and you want to enable alarms to do this, you must use PutInvestigationGroupPolicy to create a resource policy that grants this permission to CloudWatch alarms.

For more information about configuring CloudWatch alarms, see Using Amazon CloudWatch alarms

This is a convenience which creates an instance of the CreateInvestigationGroupRequest.Builder avoiding the need to create one manually via CreateInvestigationGroupRequest.builder()

Parameters:

createInvestigationGroupRequest - A Consumer that will call methods on CreateInvestigationGroupRequest.Builder to create a request.

Returns:

Result of the CreateInvestigationGroup operation returned by the service.

See Also:

• AWS API Documentation

deleteInvestigationGroup

default DeleteInvestigationGroupResponse deleteInvestigationGroup(DeleteInvestigationGroupRequest deleteInvestigationGroupRequest)
                                                           throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

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.

Parameters:

deleteInvestigationGroupRequest -

Returns:

Result of the DeleteInvestigationGroup operation returned by the service.

See Also:

• AWS API Documentation

deleteInvestigationGroup

default DeleteInvestigationGroupResponse deleteInvestigationGroup(Consumer<DeleteInvestigationGroupRequest.Builder> deleteInvestigationGroupRequest)
                                                           throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

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.

This is a convenience which creates an instance of the DeleteInvestigationGroupRequest.Builder avoiding the need to create one manually via DeleteInvestigationGroupRequest.builder()

Parameters:

deleteInvestigationGroupRequest - A Consumer that will call methods on DeleteInvestigationGroupRequest.Builder to create a request.

Returns:

Result of the DeleteInvestigationGroup operation returned by the service.

See Also:

• AWS API Documentation

deleteInvestigationGroupPolicy

default DeleteInvestigationGroupPolicyResponse deleteInvestigationGroupPolicy(DeleteInvestigationGroupPolicyRequest deleteInvestigationGroupPolicyRequest)
                                                                       throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

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

Parameters:

deleteInvestigationGroupPolicyRequest -

Returns:

Result of the DeleteInvestigationGroupPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteInvestigationGroupPolicy

default DeleteInvestigationGroupPolicyResponse deleteInvestigationGroupPolicy(Consumer<DeleteInvestigationGroupPolicyRequest.Builder> deleteInvestigationGroupPolicyRequest)
                                                                       throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

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

This is a convenience which creates an instance of the DeleteInvestigationGroupPolicyRequest.Builder avoiding the need to create one manually via DeleteInvestigationGroupPolicyRequest.builder()

Parameters:

deleteInvestigationGroupPolicyRequest - A Consumer that will call methods on DeleteInvestigationGroupPolicyRequest.Builder to create a request.

Returns:

Result of the DeleteInvestigationGroupPolicy operation returned by the service.

See Also:

• AWS API Documentation

getInvestigationGroup

default GetInvestigationGroupResponse getInvestigationGroup(GetInvestigationGroupRequest getInvestigationGroupRequest)
                                                     throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

Returns the configuration information for the specified investigation group.

Parameters:

getInvestigationGroupRequest -

Returns:

Result of the GetInvestigationGroup operation returned by the service.

See Also:

• AWS API Documentation

getInvestigationGroup

default GetInvestigationGroupResponse getInvestigationGroup(Consumer<GetInvestigationGroupRequest.Builder> getInvestigationGroupRequest)
                                                     throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

Returns the configuration information for the specified investigation group.

This is a convenience which creates an instance of the GetInvestigationGroupRequest.Builder avoiding the need to create one manually via GetInvestigationGroupRequest.builder()

Parameters:

getInvestigationGroupRequest - A Consumer that will call methods on GetInvestigationGroupRequest.Builder to create a request.

Returns:

Result of the GetInvestigationGroup operation returned by the service.

See Also:

• AWS API Documentation

getInvestigationGroupPolicy

default GetInvestigationGroupPolicyResponse getInvestigationGroupPolicy(GetInvestigationGroupPolicyRequest getInvestigationGroupPolicyRequest)
                                                                 throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

Returns the JSON of the IAM resource policy associated with the specified investigation group in a string. For example, {\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"aiops.alarms.cloudwatch.amazonaws.com\"},\"Action\":[\"aiops:CreateInvestigation\",\"aiops:CreateInvestigationEvent\"],\"Resource\":\"*\",\"Condition\":{\"StringEquals\":{\"aws:SourceAccount\":\"111122223333\"},\"ArnLike\":{\"aws:SourceArn\":\"arn:aws:cloudwatch:us-east-1:111122223333:alarm:*\"}}}]} .

Parameters:

getInvestigationGroupPolicyRequest -

Returns:

Result of the GetInvestigationGroupPolicy operation returned by the service.

See Also:

• AWS API Documentation

getInvestigationGroupPolicy

default GetInvestigationGroupPolicyResponse getInvestigationGroupPolicy(Consumer<GetInvestigationGroupPolicyRequest.Builder> getInvestigationGroupPolicyRequest)
                                                                 throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

Returns the JSON of the IAM resource policy associated with the specified investigation group in a string. For example, {\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"aiops.alarms.cloudwatch.amazonaws.com\"},\"Action\":[\"aiops:CreateInvestigation\",\"aiops:CreateInvestigationEvent\"],\"Resource\":\"*\",\"Condition\":{\"StringEquals\":{\"aws:SourceAccount\":\"111122223333\"},\"ArnLike\":{\"aws:SourceArn\":\"arn:aws:cloudwatch:us-east-1:111122223333:alarm:*\"}}}]} .

This is a convenience which creates an instance of the GetInvestigationGroupPolicyRequest.Builder avoiding the need to create one manually via GetInvestigationGroupPolicyRequest.builder()

Parameters:

getInvestigationGroupPolicyRequest - A Consumer that will call methods on GetInvestigationGroupPolicyRequest.Builder to create a request.

Returns:

Result of the GetInvestigationGroupPolicy operation returned by the service.

See Also:

• AWS API Documentation

listInvestigationGroups

default ListInvestigationGroupsResponse listInvestigationGroups(ListInvestigationGroupsRequest listInvestigationGroupsRequest)
                                                         throws AccessDeniedException,
ForbiddenException,
ThrottlingException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

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

Parameters:

listInvestigationGroupsRequest -

Returns:

Result of the ListInvestigationGroups operation returned by the service.

See Also:

• AWS API Documentation

listInvestigationGroups

default ListInvestigationGroupsResponse listInvestigationGroups(Consumer<ListInvestigationGroupsRequest.Builder> listInvestigationGroupsRequest)
                                                         throws AccessDeniedException,
ForbiddenException,
ThrottlingException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

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

This is a convenience which creates an instance of the ListInvestigationGroupsRequest.Builder avoiding the need to create one manually via ListInvestigationGroupsRequest.builder()

Parameters:

listInvestigationGroupsRequest - A Consumer that will call methods on ListInvestigationGroupsRequest.Builder to create a request.

Returns:

Result of the ListInvestigationGroups operation returned by the service.

See Also:

• AWS API Documentation

listInvestigationGroupsPaginator

default ListInvestigationGroupsIterable listInvestigationGroupsPaginator(ListInvestigationGroupsRequest listInvestigationGroupsRequest)
                                                                  throws AccessDeniedException,
ForbiddenException,
ThrottlingException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

This is a variant of listInvestigationGroups(software.amazon.awssdk.services.aiops.model.ListInvestigationGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.aiops.paginators.ListInvestigationGroupsIterable responses = client.listInvestigationGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.aiops.paginators.ListInvestigationGroupsIterable responses = client
             .listInvestigationGroupsPaginator(request);
     for (software.amazon.awssdk.services.aiops.model.ListInvestigationGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.aiops.paginators.ListInvestigationGroupsIterable responses = client.listInvestigationGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listInvestigationGroups(software.amazon.awssdk.services.aiops.model.ListInvestigationGroupsRequest) operation.

Parameters:

listInvestigationGroupsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listInvestigationGroupsPaginator

default ListInvestigationGroupsIterable listInvestigationGroupsPaginator(Consumer<ListInvestigationGroupsRequest.Builder> listInvestigationGroupsRequest)
                                                                  throws AccessDeniedException,
ForbiddenException,
ThrottlingException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

This is a variant of listInvestigationGroups(software.amazon.awssdk.services.aiops.model.ListInvestigationGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.aiops.paginators.ListInvestigationGroupsIterable responses = client.listInvestigationGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.aiops.paginators.ListInvestigationGroupsIterable responses = client
             .listInvestigationGroupsPaginator(request);
     for (software.amazon.awssdk.services.aiops.model.ListInvestigationGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.aiops.paginators.ListInvestigationGroupsIterable responses = client.listInvestigationGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listInvestigationGroups(software.amazon.awssdk.services.aiops.model.ListInvestigationGroupsRequest) operation.

This is a convenience which creates an instance of the ListInvestigationGroupsRequest.Builder avoiding the need to create one manually via ListInvestigationGroupsRequest.builder()

Parameters:

listInvestigationGroupsRequest - A Consumer that will call methods on ListInvestigationGroupsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

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

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

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

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

putInvestigationGroupPolicy

default PutInvestigationGroupPolicyResponse putInvestigationGroupPolicy(PutInvestigationGroupPolicyRequest putInvestigationGroupPolicyRequest)
                                                                 throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

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

If you create your investigation group with CreateInvestigationGroup and you want to enable CloudWatch alarms to create investigations and add events to investigations, you must use this operation to create a policy similar to this example.

{ "Version": "2008-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "aiops.alarms.cloudwatch.amazonaws.com" }, "Action": [ "aiops:CreateInvestigation", "aiops:CreateInvestigationEvent" ], "Resource": "*", "Condition": { "StringEquals": { "aws:SourceAccount": "account-id" }, "ArnLike": { "aws:SourceArn": "arn:aws:cloudwatch:region:account-id:alarm:*" } } } ] }

Parameters:

putInvestigationGroupPolicyRequest -

Returns:

Result of the PutInvestigationGroupPolicy operation returned by the service.

See Also:

• AWS API Documentation

putInvestigationGroupPolicy

default PutInvestigationGroupPolicyResponse putInvestigationGroupPolicy(Consumer<PutInvestigationGroupPolicyRequest.Builder> putInvestigationGroupPolicyRequest)
                                                                 throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

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

If you create your investigation group with CreateInvestigationGroup and you want to enable CloudWatch alarms to create investigations and add events to investigations, you must use this operation to create a policy similar to this example.

{ "Version": "2008-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "aiops.alarms.cloudwatch.amazonaws.com" }, "Action": [ "aiops:CreateInvestigation", "aiops:CreateInvestigationEvent" ], "Resource": "*", "Condition": { "StringEquals": { "aws:SourceAccount": "account-id" }, "ArnLike": { "aws:SourceArn": "arn:aws:cloudwatch:region:account-id:alarm:*" } } } ] }

This is a convenience which creates an instance of the PutInvestigationGroupPolicyRequest.Builder avoiding the need to create one manually via PutInvestigationGroupPolicyRequest.builder()

Parameters:

putInvestigationGroupPolicyRequest - A Consumer that will call methods on PutInvestigationGroupPolicyRequest.Builder to create a request.

Returns:

Result of the PutInvestigationGroupPolicy operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

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

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with a resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

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

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with a resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

Removes one or more tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

Removes one or more tags from the specified resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateInvestigationGroup

default UpdateInvestigationGroupResponse updateInvestigationGroup(UpdateInvestigationGroupRequest updateInvestigationGroupRequest)
                                                           throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

Updates the configuration of the specified investigation group.

Parameters:

updateInvestigationGroupRequest -

Returns:

Result of the UpdateInvestigationGroup operation returned by the service.

See Also:

• AWS API Documentation

updateInvestigationGroup

default UpdateInvestigationGroupResponse updateInvestigationGroup(Consumer<UpdateInvestigationGroupRequest.Builder> updateInvestigationGroupRequest)
                                                           throws AccessDeniedException,
ForbiddenException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
AiOpsException

Updates the configuration of the specified investigation group.

This is a convenience which creates an instance of the UpdateInvestigationGroupRequest.Builder avoiding the need to create one manually via UpdateInvestigationGroupRequest.builder()

Parameters:

updateInvestigationGroupRequest - A Consumer that will call methods on UpdateInvestigationGroupRequest.Builder to create a request.

Returns:

Result of the UpdateInvestigationGroup operation returned by the service.

See Also:

• AWS API Documentation

create

static AiOpsClient create()

Create a AiOpsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static AiOpsClientBuilder builder()

Create a builder that can be used to configure and create a AiOpsClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default AiOpsServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration