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
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.
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)
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
def add_notification_channel(
self,
*,
Config: NotificationChannelConfigTypeDef, # (1)
) -> AddNotificationChannelResponseTypeDef: # (2)
...
kwargs: AddNotificationChannelRequestRequestTypeDef = { # (1)
"Config": ...,
}
parent.add_notification_channel(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("devops-guru").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("devops-guru").close
method.
boto3 documentation
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
kwargs: DeleteInsightRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_insight(**kwargs)
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
def describe_account_health(
self,
) -> DescribeAccountHealthResponseTypeDef: # (1)
...
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
def describe_account_overview(
self,
*,
FromTime: Union[datetime, str],
ToTime: Union[datetime, str] = ...,
) -> DescribeAccountOverviewResponseTypeDef: # (1)
...
kwargs: DescribeAccountOverviewRequestRequestTypeDef = { # (1)
"FromTime": ...,
}
parent.describe_account_overview(**kwargs)
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
def describe_anomaly(
self,
*,
Id: str,
AccountId: str = ...,
) -> DescribeAnomalyResponseTypeDef: # (1)
...
kwargs: DescribeAnomalyRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.describe_anomaly(**kwargs)
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
def describe_event_sources_config(
self,
) -> DescribeEventSourcesConfigResponseTypeDef: # (1)
...
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
def describe_feedback(
self,
*,
InsightId: str = ...,
) -> DescribeFeedbackResponseTypeDef: # (1)
...
kwargs: DescribeFeedbackRequestRequestTypeDef = { # (1)
"InsightId": ...,
}
parent.describe_feedback(**kwargs)
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
def describe_insight(
self,
*,
Id: str,
AccountId: str = ...,
) -> DescribeInsightResponseTypeDef: # (1)
...
kwargs: DescribeInsightRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.describe_insight(**kwargs)
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
def describe_organization_health(
self,
*,
AccountIds: Sequence[str] = ...,
OrganizationalUnitIds: Sequence[str] = ...,
) -> DescribeOrganizationHealthResponseTypeDef: # (1)
...
kwargs: DescribeOrganizationHealthRequestRequestTypeDef = { # (1)
"AccountIds": ...,
}
parent.describe_organization_health(**kwargs)
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
def describe_organization_overview(
self,
*,
FromTime: Union[datetime, str],
ToTime: Union[datetime, str] = ...,
AccountIds: Sequence[str] = ...,
OrganizationalUnitIds: Sequence[str] = ...,
) -> DescribeOrganizationOverviewResponseTypeDef: # (1)
...
kwargs: DescribeOrganizationOverviewRequestRequestTypeDef = { # (1)
"FromTime": ...,
}
parent.describe_organization_overview(**kwargs)
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
def describe_organization_resource_collection_health(
self,
*,
OrganizationResourceCollectionType: OrganizationResourceCollectionTypeType, # (1)
AccountIds: Sequence[str] = ...,
OrganizationalUnitIds: Sequence[str] = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeOrganizationResourceCollectionHealthResponseTypeDef: # (2)
...
- See OrganizationResourceCollectionTypeType
- See DescribeOrganizationResourceCollectionHealthResponseTypeDef
kwargs: DescribeOrganizationResourceCollectionHealthRequestRequestTypeDef = { # (1)
"OrganizationResourceCollectionType": ...,
}
parent.describe_organization_resource_collection_health(**kwargs)
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
def describe_resource_collection_health(
self,
*,
ResourceCollectionType: ResourceCollectionTypeType, # (1)
NextToken: str = ...,
) -> DescribeResourceCollectionHealthResponseTypeDef: # (2)
...
kwargs: DescribeResourceCollectionHealthRequestRequestTypeDef = { # (1)
"ResourceCollectionType": ...,
}
parent.describe_resource_collection_health(**kwargs)
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
def describe_service_integration(
self,
) -> DescribeServiceIntegrationResponseTypeDef: # (1)
...
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
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
def get_cost_estimation(
self,
*,
NextToken: str = ...,
) -> GetCostEstimationResponseTypeDef: # (1)
...
kwargs: GetCostEstimationRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.get_cost_estimation(**kwargs)
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
def get_resource_collection(
self,
*,
ResourceCollectionType: ResourceCollectionTypeType, # (1)
NextToken: str = ...,
) -> GetResourceCollectionResponseTypeDef: # (2)
...
kwargs: GetResourceCollectionRequestRequestTypeDef = { # (1)
"ResourceCollectionType": ...,
}
parent.get_resource_collection(**kwargs)
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
def list_anomalies_for_insight(
self,
*,
InsightId: str,
StartTimeRange: StartTimeRangeTypeDef = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
AccountId: str = ...,
Filters: ListAnomaliesForInsightFiltersTypeDef = ..., # (2)
) -> ListAnomaliesForInsightResponseTypeDef: # (3)
...
- See StartTimeRangeTypeDef
- See ListAnomaliesForInsightFiltersTypeDef
- See ListAnomaliesForInsightResponseTypeDef
kwargs: ListAnomaliesForInsightRequestRequestTypeDef = { # (1)
"InsightId": ...,
}
parent.list_anomalies_for_insight(**kwargs)
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
def list_anomalous_log_groups(
self,
*,
InsightId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAnomalousLogGroupsResponseTypeDef: # (1)
...
kwargs: ListAnomalousLogGroupsRequestRequestTypeDef = { # (1)
"InsightId": ...,
}
parent.list_anomalous_log_groups(**kwargs)
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
def list_events(
self,
*,
Filters: ListEventsFiltersTypeDef, # (1)
MaxResults: int = ...,
NextToken: str = ...,
AccountId: str = ...,
) -> ListEventsResponseTypeDef: # (2)
...
kwargs: ListEventsRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.list_events(**kwargs)
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
def list_insights(
self,
*,
StatusFilter: ListInsightsStatusFilterTypeDef, # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListInsightsResponseTypeDef: # (2)
...
kwargs: ListInsightsRequestRequestTypeDef = { # (1)
"StatusFilter": ...,
}
parent.list_insights(**kwargs)
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
def list_monitored_resources(
self,
*,
Filters: ListMonitoredResourcesFiltersTypeDef = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListMonitoredResourcesResponseTypeDef: # (2)
...
kwargs: ListMonitoredResourcesRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.list_monitored_resources(**kwargs)
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
def list_notification_channels(
self,
*,
NextToken: str = ...,
) -> ListNotificationChannelsResponseTypeDef: # (1)
...
kwargs: ListNotificationChannelsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_notification_channels(**kwargs)
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
def list_organization_insights(
self,
*,
StatusFilter: ListInsightsStatusFilterTypeDef, # (1)
MaxResults: int = ...,
AccountIds: Sequence[str] = ...,
OrganizationalUnitIds: Sequence[str] = ...,
NextToken: str = ...,
) -> ListOrganizationInsightsResponseTypeDef: # (2)
...
kwargs: ListOrganizationInsightsRequestRequestTypeDef = { # (1)
"StatusFilter": ...,
}
parent.list_organization_insights(**kwargs)
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
def list_recommendations(
self,
*,
InsightId: str,
NextToken: str = ...,
Locale: LocaleType = ..., # (1)
AccountId: str = ...,
) -> ListRecommendationsResponseTypeDef: # (2)
...
kwargs: ListRecommendationsRequestRequestTypeDef = { # (1)
"InsightId": ...,
}
parent.list_recommendations(**kwargs)
put_feedback
Collects customer feedback about the specified insight.
Type annotations and code completion for boto3.client("devops-guru").put_feedback
method.
boto3 documentation
def put_feedback(
self,
*,
InsightFeedback: InsightFeedbackTypeDef = ..., # (1)
) -> Dict[str, Any]:
...
kwargs: PutFeedbackRequestRequestTypeDef = { # (1)
"InsightFeedback": ...,
}
parent.put_feedback(**kwargs)
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
kwargs: RemoveNotificationChannelRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.remove_notification_channel(**kwargs)
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
def search_insights(
self,
*,
StartTimeRange: StartTimeRangeTypeDef, # (1)
Type: InsightTypeType, # (2)
Filters: SearchInsightsFiltersTypeDef = ..., # (3)
MaxResults: int = ...,
NextToken: str = ...,
) -> SearchInsightsResponseTypeDef: # (4)
...
- See StartTimeRangeTypeDef
- See InsightTypeType
- See SearchInsightsFiltersTypeDef
- See SearchInsightsResponseTypeDef
kwargs: SearchInsightsRequestRequestTypeDef = { # (1)
"StartTimeRange": ...,
"Type": ...,
}
parent.search_insights(**kwargs)
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
def search_organization_insights(
self,
*,
AccountIds: Sequence[str],
StartTimeRange: StartTimeRangeTypeDef, # (1)
Type: InsightTypeType, # (2)
Filters: SearchOrganizationInsightsFiltersTypeDef = ..., # (3)
MaxResults: int = ...,
NextToken: str = ...,
) -> SearchOrganizationInsightsResponseTypeDef: # (4)
...
- See StartTimeRangeTypeDef
- See InsightTypeType
- See SearchOrganizationInsightsFiltersTypeDef
- See SearchOrganizationInsightsResponseTypeDef
kwargs: SearchOrganizationInsightsRequestRequestTypeDef = { # (1)
"AccountIds": ...,
"StartTimeRange": ...,
"Type": ...,
}
parent.search_organization_insights(**kwargs)
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
def start_cost_estimation(
self,
*,
ResourceCollection: CostEstimationResourceCollectionFilterTypeDef, # (1)
ClientToken: str = ...,
) -> Dict[str, Any]:
...
kwargs: StartCostEstimationRequestRequestTypeDef = { # (1)
"ResourceCollection": ...,
}
parent.start_cost_estimation(**kwargs)
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
def update_event_sources_config(
self,
*,
EventSources: EventSourcesConfigTypeDef = ..., # (1)
) -> Dict[str, Any]:
...
kwargs: UpdateEventSourcesConfigRequestRequestTypeDef = { # (1)
"EventSources": ...,
}
parent.update_event_sources_config(**kwargs)
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
def update_resource_collection(
self,
*,
Action: UpdateResourceCollectionActionType, # (1)
ResourceCollection: UpdateResourceCollectionFilterTypeDef, # (2)
) -> Dict[str, Any]:
...
kwargs: UpdateResourceCollectionRequestRequestTypeDef = { # (1)
"Action": ...,
"ResourceCollection": ...,
}
parent.update_resource_collection(**kwargs)
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
def update_service_integration(
self,
*,
ServiceIntegration: UpdateServiceIntegrationConfigTypeDef, # (1)
) -> Dict[str, Any]:
...
kwargs: UpdateServiceIntegrationRequestRequestTypeDef = { # (1)
"ServiceIntegration": ...,
}
parent.update_service_integration(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("devops-guru").get_paginator
method with overloads.
client.get_paginator("describe_organization_resource_collection_health")
-> DescribeOrganizationResourceCollectionHealthPaginatorclient.get_paginator("describe_resource_collection_health")
-> DescribeResourceCollectionHealthPaginatorclient.get_paginator("get_cost_estimation")
-> GetCostEstimationPaginatorclient.get_paginator("get_resource_collection")
-> GetResourceCollectionPaginatorclient.get_paginator("list_anomalies_for_insight")
-> ListAnomaliesForInsightPaginatorclient.get_paginator("list_anomalous_log_groups")
-> ListAnomalousLogGroupsPaginatorclient.get_paginator("list_events")
-> ListEventsPaginatorclient.get_paginator("list_insights")
-> ListInsightsPaginatorclient.get_paginator("list_monitored_resources")
-> ListMonitoredResourcesPaginatorclient.get_paginator("list_notification_channels")
-> ListNotificationChannelsPaginatorclient.get_paginator("list_organization_insights")
-> ListOrganizationInsightsPaginatorclient.get_paginator("list_recommendations")
-> ListRecommendationsPaginatorclient.get_paginator("search_insights")
-> SearchInsightsPaginatorclient.get_paginator("search_organization_insights")
-> SearchOrganizationInsightsPaginator