Skip to content

AIOpsClient#

Index > AIOps > AIOpsClient

Auto-generated documentation for AIOps type annotations stubs module types-boto3-aiops.

AIOpsClient#

Type annotations and code completion for boto3.client("aiops"). boto3 documentation

# AIOpsClient usage example

from boto3.session import Session
from types_boto3_aiops.client import AIOpsClient

def get_aiops_client() -> AIOpsClient:
    return Session().client("aiops")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("aiops").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("aiops")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.ForbiddenException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_aiops.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("aiops").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("aiops").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_investigation_group#

Creates an investigation group in your account.

Type annotations and code completion for boto3.client("aiops").create_investigation_group method. boto3 documentation

# create_investigation_group method definition

def create_investigation_group(
    self,
    *,
    name: str,
    roleArn: str,
    encryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (1)
    retentionInDays: int = ...,
    tags: Mapping[str, str] = ...,
    tagKeyBoundaries: Sequence[str] = ...,
    chatbotNotificationChannel: Mapping[str, Sequence[str]] = ...,
    isCloudTrailEventHistoryEnabled: bool = ...,
) -> CreateInvestigationGroupOutputTypeDef:  # (2)
    ...
  1. See EncryptionConfigurationTypeDef
  2. See CreateInvestigationGroupOutputTypeDef
# create_investigation_group method usage example with argument unpacking

kwargs: CreateInvestigationGroupInputTypeDef = {  # (1)
    "name": ...,
    "roleArn": ...,
}

parent.create_investigation_group(**kwargs)
  1. See CreateInvestigationGroupInputTypeDef

delete_investigation_group#

Deletes the specified investigation group from your account.

Type annotations and code completion for boto3.client("aiops").delete_investigation_group method. boto3 documentation

# delete_investigation_group method definition

def delete_investigation_group(
    self,
    *,
    identifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_investigation_group method usage example with argument unpacking

kwargs: DeleteInvestigationGroupRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.delete_investigation_group(**kwargs)
  1. See DeleteInvestigationGroupRequestTypeDef

delete_investigation_group_policy#

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

Type annotations and code completion for boto3.client("aiops").delete_investigation_group_policy method. boto3 documentation

# delete_investigation_group_policy method definition

def delete_investigation_group_policy(
    self,
    *,
    identifier: str,
) -> Dict[str, Any]:
    ...
# delete_investigation_group_policy method usage example with argument unpacking

kwargs: DeleteInvestigationGroupPolicyRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.delete_investigation_group_policy(**kwargs)
  1. See DeleteInvestigationGroupPolicyRequestTypeDef

get_investigation_group#

Returns the configuration information for the specified investigation group.

Type annotations and code completion for boto3.client("aiops").get_investigation_group method. boto3 documentation

# get_investigation_group method definition

def get_investigation_group(
    self,
    *,
    identifier: str,
) -> GetInvestigationGroupResponseTypeDef:  # (1)
    ...
  1. See GetInvestigationGroupResponseTypeDef
# get_investigation_group method usage example with argument unpacking

kwargs: GetInvestigationGroupRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.get_investigation_group(**kwargs)
  1. See GetInvestigationGroupRequestTypeDef

get_investigation_group_policy#

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

Type annotations and code completion for boto3.client("aiops").get_investigation_group_policy method. boto3 documentation

# get_investigation_group_policy method definition

def get_investigation_group_policy(
    self,
    *,
    identifier: str,
) -> GetInvestigationGroupPolicyResponseTypeDef:  # (1)
    ...
  1. See GetInvestigationGroupPolicyResponseTypeDef
# get_investigation_group_policy method usage example with argument unpacking

kwargs: GetInvestigationGroupPolicyRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.get_investigation_group_policy(**kwargs)
  1. See GetInvestigationGroupPolicyRequestTypeDef

list_investigation_groups#

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

Type annotations and code completion for boto3.client("aiops").list_investigation_groups method. boto3 documentation

# list_investigation_groups method definition

def list_investigation_groups(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListInvestigationGroupsOutputTypeDef:  # (1)
    ...
  1. See ListInvestigationGroupsOutputTypeDef
# list_investigation_groups method usage example with argument unpacking

kwargs: ListInvestigationGroupsInputTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_investigation_groups(**kwargs)
  1. See ListInvestigationGroupsInputTypeDef

list_tags_for_resource#

Displays the tags associated with a Amazon Q Developer operational investigations resource.

Type annotations and code completion for boto3.client("aiops").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

put_investigation_group_policy#

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

Type annotations and code completion for boto3.client("aiops").put_investigation_group_policy method. boto3 documentation

# put_investigation_group_policy method definition

def put_investigation_group_policy(
    self,
    *,
    identifier: str,
    policy: str,
) -> PutInvestigationGroupPolicyResponseTypeDef:  # (1)
    ...
  1. See PutInvestigationGroupPolicyResponseTypeDef
# put_investigation_group_policy method usage example with argument unpacking

kwargs: PutInvestigationGroupPolicyRequestTypeDef = {  # (1)
    "identifier": ...,
    "policy": ...,
}

parent.put_investigation_group_policy(**kwargs)
  1. See PutInvestigationGroupPolicyRequestTypeDef

tag_resource#

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

Type annotations and code completion for boto3.client("aiops").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Removes one or more tags from the specified resource.

Type annotations and code completion for boto3.client("aiops").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_investigation_group#

Updates the configuration of the specified investigation group.

Type annotations and code completion for boto3.client("aiops").update_investigation_group method. boto3 documentation

# update_investigation_group method definition

def update_investigation_group(
    self,
    *,
    identifier: str,
    roleArn: str = ...,
    encryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (1)
    tagKeyBoundaries: Sequence[str] = ...,
    chatbotNotificationChannel: Mapping[str, Sequence[str]] = ...,
    isCloudTrailEventHistoryEnabled: bool = ...,
) -> Dict[str, Any]:
    ...
  1. See EncryptionConfigurationTypeDef
# update_investigation_group method usage example with argument unpacking

kwargs: UpdateInvestigationGroupRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.update_investigation_group(**kwargs)
  1. See UpdateInvestigationGroupRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("aiops").get_paginator method with overloads.