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

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.

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

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)
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

Method definition
def add_notification_channel(
    self,
    *,
    Config: NotificationChannelConfigTypeDef,  # (1)
) -> AddNotificationChannelResponseTypeDef:  # (2)
    ...
  1. See NotificationChannelConfigTypeDef
  2. See AddNotificationChannelResponseTypeDef
Usage example with kwargs
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

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

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

Method definition
def delete_insight(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

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

Method definition
def describe_account_overview(
    self,
    *,
    FromTime: Union[datetime, str],
    ToTime: Union[datetime, str] = ...,
) -> DescribeAccountOverviewResponseTypeDef:  # (1)
    ...
  1. See DescribeAccountOverviewResponseTypeDef
Usage example with kwargs
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

Method definition
def describe_anomaly(
    self,
    *,
    Id: str,
    AccountId: str = ...,
) -> DescribeAnomalyResponseTypeDef:  # (1)
    ...
  1. See DescribeAnomalyResponseTypeDef
Usage example with kwargs
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

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

Method definition
def describe_feedback(
    self,
    *,
    InsightId: str = ...,
) -> DescribeFeedbackResponseTypeDef:  # (1)
    ...
  1. See DescribeFeedbackResponseTypeDef
Usage example with kwargs
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

Method definition
def describe_insight(
    self,
    *,
    Id: str,
    AccountId: str = ...,
) -> DescribeInsightResponseTypeDef:  # (1)
    ...
  1. See DescribeInsightResponseTypeDef
Usage example with kwargs
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

Method definition
def describe_organization_health(
    self,
    *,
    AccountIds: Sequence[str] = ...,
    OrganizationalUnitIds: Sequence[str] = ...,
) -> DescribeOrganizationHealthResponseTypeDef:  # (1)
    ...
  1. See DescribeOrganizationHealthResponseTypeDef
Usage example with kwargs
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

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
Usage example with kwargs
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

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
Usage example with kwargs
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. boto3 documentation

Method definition
def describe_resource_collection_health(
    self,
    *,
    ResourceCollectionType: ResourceCollectionTypeType,  # (1)
    NextToken: str = ...,
) -> DescribeResourceCollectionHealthResponseTypeDef:  # (2)
    ...
  1. See ResourceCollectionTypeType
  2. See DescribeResourceCollectionHealthResponseTypeDef
Usage example with kwargs
kwargs: DescribeResourceCollectionHealthRequestRequestTypeDef = {  # (1)
    "ResourceCollectionType": ...,
}

parent.describe_resource_collection_health(**kwargs)
  1. See DescribeResourceCollectionHealthRequestRequestTypeDef

describe_service_integration

Returns the integration status of services that are integrated with DevOps Guru.

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

Method definition
def describe_service_integration(
    self,
) -> DescribeServiceIntegrationResponseTypeDef:  # (1)
    ...
  1. See DescribeServiceIntegrationResponseTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

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

get_cost_estimation

Returns an estimate of the monthly cost for DevOps Guru to analyze your Amazon Web Services resources.

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

Method definition
def get_cost_estimation(
    self,
    *,
    NextToken: str = ...,
) -> GetCostEstimationResponseTypeDef:  # (1)
    ...
  1. See GetCostEstimationResponseTypeDef
Usage example with kwargs
kwargs: GetCostEstimationRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.get_cost_estimation(**kwargs)
  1. See GetCostEstimationRequestRequestTypeDef

get_resource_collection

Returns lists Amazon Web Services resources that are of the specified resource collection type.

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

Method definition
def get_resource_collection(
    self,
    *,
    ResourceCollectionType: ResourceCollectionTypeType,  # (1)
    NextToken: str = ...,
) -> GetResourceCollectionResponseTypeDef:  # (2)
    ...
  1. See ResourceCollectionTypeType
  2. See GetResourceCollectionResponseTypeDef
Usage example with kwargs
kwargs: GetResourceCollectionRequestRequestTypeDef = {  # (1)
    "ResourceCollectionType": ...,
}

parent.get_resource_collection(**kwargs)
  1. See GetResourceCollectionRequestRequestTypeDef

list_anomalies_for_insight

Returns a list of the anomalies that belong to an insight that you specify using its ID.

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

Method definition
def list_anomalies_for_insight(
    self,
    *,
    InsightId: str,
    StartTimeRange: StartTimeRangeTypeDef = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
    AccountId: str = ...,
) -> ListAnomaliesForInsightResponseTypeDef:  # (2)
    ...
  1. See StartTimeRangeTypeDef
  2. See ListAnomaliesForInsightResponseTypeDef
Usage example with kwargs
kwargs: ListAnomaliesForInsightRequestRequestTypeDef = {  # (1)
    "InsightId": ...,
}

parent.list_anomalies_for_insight(**kwargs)
  1. See ListAnomaliesForInsightRequestRequestTypeDef

list_anomalous_log_groups

Returns the list of log groups that contain log anomalies.

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

Method definition
def list_anomalous_log_groups(
    self,
    *,
    InsightId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAnomalousLogGroupsResponseTypeDef:  # (1)
    ...
  1. See ListAnomalousLogGroupsResponseTypeDef
Usage example with kwargs
kwargs: ListAnomalousLogGroupsRequestRequestTypeDef = {  # (1)
    "InsightId": ...,
}

parent.list_anomalous_log_groups(**kwargs)
  1. See ListAnomalousLogGroupsRequestRequestTypeDef

list_events

Returns a list of the events emitted by the resources that are evaluated by DevOps Guru.

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

Method definition
def list_events(
    self,
    *,
    Filters: ListEventsFiltersTypeDef,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
    AccountId: str = ...,
) -> ListEventsResponseTypeDef:  # (2)
    ...
  1. See ListEventsFiltersTypeDef
  2. See ListEventsResponseTypeDef
Usage example with kwargs
kwargs: ListEventsRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.list_events(**kwargs)
  1. See ListEventsRequestRequestTypeDef

list_insights

Returns a list of insights in your Amazon Web Services account.

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

Method definition
def list_insights(
    self,
    *,
    StatusFilter: ListInsightsStatusFilterTypeDef,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListInsightsResponseTypeDef:  # (2)
    ...
  1. See ListInsightsStatusFilterTypeDef
  2. See ListInsightsResponseTypeDef
Usage example with kwargs
kwargs: ListInsightsRequestRequestTypeDef = {  # (1)
    "StatusFilter": ...,
}

parent.list_insights(**kwargs)
  1. See ListInsightsRequestRequestTypeDef

list_monitored_resources

Returns the list of all log groups that are being monitored and tagged by DevOps Guru.

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

Method definition
def list_monitored_resources(
    self,
    *,
    Filters: ListMonitoredResourcesFiltersTypeDef,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListMonitoredResourcesResponseTypeDef:  # (2)
    ...
  1. See ListMonitoredResourcesFiltersTypeDef
  2. See ListMonitoredResourcesResponseTypeDef
Usage example with kwargs
kwargs: ListMonitoredResourcesRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.list_monitored_resources(**kwargs)
  1. See ListMonitoredResourcesRequestRequestTypeDef

list_notification_channels

Returns a list of notification channels configured for DevOps Guru.

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

Method definition
def list_notification_channels(
    self,
    *,
    NextToken: str = ...,
) -> ListNotificationChannelsResponseTypeDef:  # (1)
    ...
  1. See ListNotificationChannelsResponseTypeDef
Usage example with kwargs
kwargs: ListNotificationChannelsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_notification_channels(**kwargs)
  1. See ListNotificationChannelsRequestRequestTypeDef

list_organization_insights

Returns a list of insights associated with the account or OU Id.

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

Method definition
def list_organization_insights(
    self,
    *,
    StatusFilter: ListInsightsStatusFilterTypeDef,  # (1)
    MaxResults: int = ...,
    AccountIds: Sequence[str] = ...,
    OrganizationalUnitIds: Sequence[str] = ...,
    NextToken: str = ...,
) -> ListOrganizationInsightsResponseTypeDef:  # (2)
    ...
  1. See ListInsightsStatusFilterTypeDef
  2. See ListOrganizationInsightsResponseTypeDef
Usage example with kwargs
kwargs: ListOrganizationInsightsRequestRequestTypeDef = {  # (1)
    "StatusFilter": ...,
}

parent.list_organization_insights(**kwargs)
  1. See ListOrganizationInsightsRequestRequestTypeDef

list_recommendations

Returns a list of a specified insight's recommendations.

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

Method definition
def list_recommendations(
    self,
    *,
    InsightId: str,
    NextToken: str = ...,
    Locale: LocaleType = ...,  # (1)
    AccountId: str = ...,
) -> ListRecommendationsResponseTypeDef:  # (2)
    ...
  1. See LocaleType
  2. See ListRecommendationsResponseTypeDef
Usage example with kwargs
kwargs: ListRecommendationsRequestRequestTypeDef = {  # (1)
    "InsightId": ...,
}

parent.list_recommendations(**kwargs)
  1. See ListRecommendationsRequestRequestTypeDef

put_feedback

Collects customer feedback about the specified insight.

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

Method definition
def put_feedback(
    self,
    *,
    InsightFeedback: InsightFeedbackTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See InsightFeedbackTypeDef
Usage example with kwargs
kwargs: PutFeedbackRequestRequestTypeDef = {  # (1)
    "InsightFeedback": ...,
}

parent.put_feedback(**kwargs)
  1. See PutFeedbackRequestRequestTypeDef

remove_notification_channel

Removes a notification channel from DevOps Guru.

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

Method definition
def remove_notification_channel(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: RemoveNotificationChannelRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.remove_notification_channel(**kwargs)
  1. See RemoveNotificationChannelRequestRequestTypeDef

search_insights

Returns a list of insights in your Amazon Web Services account.

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

Method definition
def search_insights(
    self,
    *,
    StartTimeRange: StartTimeRangeTypeDef,  # (1)
    Type: InsightTypeType,  # (2)
    Filters: SearchInsightsFiltersTypeDef = ...,  # (3)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> SearchInsightsResponseTypeDef:  # (4)
    ...
  1. See StartTimeRangeTypeDef
  2. See InsightTypeType
  3. See SearchInsightsFiltersTypeDef
  4. See SearchInsightsResponseTypeDef
Usage example with kwargs
kwargs: SearchInsightsRequestRequestTypeDef = {  # (1)
    "StartTimeRange": ...,
    "Type": ...,
}

parent.search_insights(**kwargs)
  1. See SearchInsightsRequestRequestTypeDef

search_organization_insights

Returns a list of insights in your organization.

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

Method definition
def search_organization_insights(
    self,
    *,
    AccountIds: Sequence[str],
    StartTimeRange: StartTimeRangeTypeDef,  # (1)
    Type: InsightTypeType,  # (2)
    Filters: SearchOrganizationInsightsFiltersTypeDef = ...,  # (3)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> SearchOrganizationInsightsResponseTypeDef:  # (4)
    ...
  1. See StartTimeRangeTypeDef
  2. See InsightTypeType
  3. See SearchOrganizationInsightsFiltersTypeDef
  4. See SearchOrganizationInsightsResponseTypeDef
Usage example with kwargs
kwargs: SearchOrganizationInsightsRequestRequestTypeDef = {  # (1)
    "AccountIds": ...,
    "StartTimeRange": ...,
    "Type": ...,
}

parent.search_organization_insights(**kwargs)
  1. See SearchOrganizationInsightsRequestRequestTypeDef

start_cost_estimation

Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources.

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

Method definition
def start_cost_estimation(
    self,
    *,
    ResourceCollection: CostEstimationResourceCollectionFilterTypeDef,  # (1)
    ClientToken: str = ...,
) -> Dict[str, Any]:
    ...
  1. See CostEstimationResourceCollectionFilterTypeDef
Usage example with kwargs
kwargs: StartCostEstimationRequestRequestTypeDef = {  # (1)
    "ResourceCollection": ...,
}

parent.start_cost_estimation(**kwargs)
  1. See StartCostEstimationRequestRequestTypeDef

update_event_sources_config

Enables or disables integration with a service that can be integrated with DevOps Guru.

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

Method definition
def update_event_sources_config(
    self,
    *,
    EventSources: EventSourcesConfigTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See EventSourcesConfigTypeDef
Usage example with kwargs
kwargs: UpdateEventSourcesConfigRequestRequestTypeDef = {  # (1)
    "EventSources": ...,
}

parent.update_event_sources_config(**kwargs)
  1. See UpdateEventSourcesConfigRequestRequestTypeDef

update_resource_collection

Updates the collection of resources that DevOps Guru analyzes.

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

Method definition
def update_resource_collection(
    self,
    *,
    Action: UpdateResourceCollectionActionType,  # (1)
    ResourceCollection: UpdateResourceCollectionFilterTypeDef,  # (2)
) -> Dict[str, Any]:
    ...
  1. See UpdateResourceCollectionActionType
  2. See UpdateResourceCollectionFilterTypeDef
Usage example with kwargs
kwargs: UpdateResourceCollectionRequestRequestTypeDef = {  # (1)
    "Action": ...,
    "ResourceCollection": ...,
}

parent.update_resource_collection(**kwargs)
  1. See UpdateResourceCollectionRequestRequestTypeDef

update_service_integration

Enables or disables integration with a service that can be integrated with DevOps Guru.

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

Method definition
def update_service_integration(
    self,
    *,
    ServiceIntegration: UpdateServiceIntegrationConfigTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See UpdateServiceIntegrationConfigTypeDef
Usage example with kwargs
kwargs: UpdateServiceIntegrationRequestRequestTypeDef = {  # (1)
    "ServiceIntegration": ...,
}

parent.update_service_integration(**kwargs)
  1. See UpdateServiceIntegrationRequestRequestTypeDef

get_paginator

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