Skip to content

DevOpsGuruClient#

Index > DevOpsGuru > DevOpsGuruClient

Auto-generated documentation for DevOpsGuru type annotations stubs module mypy-boto3-devops-guru.

DevOpsGuruClient#

Type annotations and code completion for boto3.client("devops-guru"). boto3 documentation

# DevOpsGuruClient usage example

from boto3.session import Session
from mypy_boto3_devops_guru.client import DevOpsGuruClient

def get_devops-guru_client() -> DevOpsGuruClient:
    return Session().client("devops-guru")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("devops-guru")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    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 mypy_boto3_devops_guru.client import Exceptions

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

Methods#

add_notification_channel#

Adds a notification channel to DevOps Guru.

Type annotations and code completion for boto3.client("devops-guru").add_notification_channel method. boto3 documentation

# add_notification_channel method definition

def add_notification_channel(
    self,
    *,
    Config: NotificationChannelConfigTypeDef,  # (1)
) -> AddNotificationChannelResponseTypeDef:  # (2)
    ...
  1. See NotificationChannelConfigTypeDef
  2. See AddNotificationChannelResponseTypeDef
# add_notification_channel method usage example with argument unpacking

kwargs: AddNotificationChannelRequestRequestTypeDef = {  # (1)
    "Config": ...,
}

parent.add_notification_channel(**kwargs)
  1. See AddNotificationChannelRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("devops-guru").can_paginate method. boto3 documentation

# can_paginate method definition

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

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("devops-guru").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

delete_insight#

Deletes the insight along with the associated anomalies, events and recommendations.

Type annotations and code completion for boto3.client("devops-guru").delete_insight method. boto3 documentation

# delete_insight method definition

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

kwargs: DeleteInsightRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_insight(**kwargs)
  1. See DeleteInsightRequestRequestTypeDef

describe_account_health#

Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your Amazon Web Services account.

Type annotations and code completion for boto3.client("devops-guru").describe_account_health method. boto3 documentation

# describe_account_health method definition

def describe_account_health(
    self,
) -> DescribeAccountHealthResponseTypeDef:  # (1)
    ...
  1. See DescribeAccountHealthResponseTypeDef

describe_account_overview#

For the time range passed in, returns the number of open reactive insight that were created, the number of open proactive insights that were created, and the Mean Time to Recover (MTTR) for all closed reactive insights.

Type annotations and code completion for boto3.client("devops-guru").describe_account_overview method. boto3 documentation

# describe_account_overview method definition

def describe_account_overview(
    self,
    *,
    FromTime: Union[datetime, str],
    ToTime: Union[datetime, str] = ...,
) -> DescribeAccountOverviewResponseTypeDef:  # (1)
    ...
  1. See DescribeAccountOverviewResponseTypeDef
# describe_account_overview method usage example with argument unpacking

kwargs: DescribeAccountOverviewRequestRequestTypeDef = {  # (1)
    "FromTime": ...,
}

parent.describe_account_overview(**kwargs)
  1. See DescribeAccountOverviewRequestRequestTypeDef

describe_anomaly#

Returns details about an anomaly that you specify using its ID.

Type annotations and code completion for boto3.client("devops-guru").describe_anomaly method. boto3 documentation

# describe_anomaly method definition

def describe_anomaly(
    self,
    *,
    Id: str,
    AccountId: str = ...,
) -> DescribeAnomalyResponseTypeDef:  # (1)
    ...
  1. See DescribeAnomalyResponseTypeDef
# describe_anomaly method usage example with argument unpacking

kwargs: DescribeAnomalyRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.describe_anomaly(**kwargs)
  1. See DescribeAnomalyRequestRequestTypeDef

describe_event_sources_config#

Returns the integration status of services that are integrated with DevOps Guru as Consumer via EventBridge.

Type annotations and code completion for boto3.client("devops-guru").describe_event_sources_config method. boto3 documentation

# describe_event_sources_config method definition

def describe_event_sources_config(
    self,
) -> DescribeEventSourcesConfigResponseTypeDef:  # (1)
    ...
  1. See DescribeEventSourcesConfigResponseTypeDef

describe_feedback#

Returns the most recent feedback submitted in the current Amazon Web Services account and Region.

Type annotations and code completion for boto3.client("devops-guru").describe_feedback method. boto3 documentation

# describe_feedback method definition

def describe_feedback(
    self,
    *,
    InsightId: str = ...,
) -> DescribeFeedbackResponseTypeDef:  # (1)
    ...
  1. See DescribeFeedbackResponseTypeDef
# describe_feedback method usage example with argument unpacking

kwargs: DescribeFeedbackRequestRequestTypeDef = {  # (1)
    "InsightId": ...,
}

parent.describe_feedback(**kwargs)
  1. See DescribeFeedbackRequestRequestTypeDef

describe_insight#

Returns details about an insight that you specify using its ID.

Type annotations and code completion for boto3.client("devops-guru").describe_insight method. boto3 documentation

# describe_insight method definition

def describe_insight(
    self,
    *,
    Id: str,
    AccountId: str = ...,
) -> DescribeInsightResponseTypeDef:  # (1)
    ...
  1. See DescribeInsightResponseTypeDef
# describe_insight method usage example with argument unpacking

kwargs: DescribeInsightRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.describe_insight(**kwargs)
  1. See DescribeInsightRequestRequestTypeDef

describe_organization_health#

Returns active insights, predictive insights, and resource hours analyzed in last hour.

Type annotations and code completion for boto3.client("devops-guru").describe_organization_health method. boto3 documentation

# describe_organization_health method definition

def describe_organization_health(
    self,
    *,
    AccountIds: Sequence[str] = ...,
    OrganizationalUnitIds: Sequence[str] = ...,
) -> DescribeOrganizationHealthResponseTypeDef:  # (1)
    ...
  1. See DescribeOrganizationHealthResponseTypeDef
# describe_organization_health method usage example with argument unpacking

kwargs: DescribeOrganizationHealthRequestRequestTypeDef = {  # (1)
    "AccountIds": ...,
}

parent.describe_organization_health(**kwargs)
  1. See DescribeOrganizationHealthRequestRequestTypeDef

describe_organization_overview#

Returns an overview of your organization's history based on the specified time range.

Type annotations and code completion for boto3.client("devops-guru").describe_organization_overview method. boto3 documentation

# describe_organization_overview method definition

def describe_organization_overview(
    self,
    *,
    FromTime: Union[datetime, str],
    ToTime: Union[datetime, str] = ...,
    AccountIds: Sequence[str] = ...,
    OrganizationalUnitIds: Sequence[str] = ...,
) -> DescribeOrganizationOverviewResponseTypeDef:  # (1)
    ...
  1. See DescribeOrganizationOverviewResponseTypeDef
# describe_organization_overview method usage example with argument unpacking

kwargs: DescribeOrganizationOverviewRequestRequestTypeDef = {  # (1)
    "FromTime": ...,
}

parent.describe_organization_overview(**kwargs)
  1. See DescribeOrganizationOverviewRequestRequestTypeDef

describe_organization_resource_collection_health#

Provides an overview of your system's health.

Type annotations and code completion for boto3.client("devops-guru").describe_organization_resource_collection_health method. boto3 documentation

# describe_organization_resource_collection_health method definition

def describe_organization_resource_collection_health(
    self,
    *,
    OrganizationResourceCollectionType: OrganizationResourceCollectionTypeType,  # (1)
    AccountIds: Sequence[str] = ...,
    OrganizationalUnitIds: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeOrganizationResourceCollectionHealthResponseTypeDef:  # (2)
    ...
  1. See OrganizationResourceCollectionTypeType
  2. See DescribeOrganizationResourceCollectionHealthResponseTypeDef
# describe_organization_resource_collection_health method usage example with argument unpacking

kwargs: DescribeOrganizationResourceCollectionHealthRequestRequestTypeDef = {  # (1)
    "OrganizationResourceCollectionType": ...,
}

parent.describe_organization_resource_collection_health(**kwargs)
  1. See DescribeOrganizationResourceCollectionHealthRequestRequestTypeDef

describe_resource_collection_health#

Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in resource collections in your account.

Type annotations and code completion for boto3.client("devops-guru").describe_resource_collection_health method.