DevOpsGuruClient#
Index > DevOpsGuru > DevOpsGuruClient
Auto-generated documentation for DevOpsGuru type annotations stubs module types-aiobotocore-devops-guru.
DevOpsGuruClient#
Type annotations and code completion for session.client("devops-guru")
boto3 documentation
# DevOpsGuruClient usage example
from aioboto3.session import Session
from types_aiobotocore_devops_guru.client import DevOpsGuruClient
session = Session()
async with session.client("devops-guru") as client:
client: DevOpsGuruClient
Exceptions#
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("devops-guru").exceptions
structure.
# DevOpsGuruClient.exceptions usage example
async with session.client("devops-guru") as client:
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)
# DevOpsGuruClient.exceptions type checking example
from types_aiobotocore_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 session.client("devops-guru").add_notification_channel
method.
boto3 documentation
# add_notification_channel method definition
await def add_notification_channel(
self,
*,
Config: NotificationChannelConfigTypeDef, # (1)
) -> AddNotificationChannelResponseTypeDef: # (2)
...
# add_notification_channel method usage example with argument unpacking
kwargs: AddNotificationChannelRequestRequestTypeDef = { # (1)
"Config": ...,
}
parent.add_notification_channel(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.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 session.client("devops-guru").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
delete_insight#
Deletes the insight along with the associated anomalies, events and recommendations.
Type annotations and code completion for session.client("devops-guru").delete_insight
method.
boto3 documentation
# delete_insight method definition
await 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)
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 session.client("devops-guru").describe_account_health
method.
boto3 documentation
# describe_account_health method definition
await 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 session.client("devops-guru").describe_account_overview
method.
boto3 documentation
# describe_account_overview method definition
await def describe_account_overview(
self,
*,
FromTime: Union[datetime, str],
ToTime: Union[datetime, str] = ...,
) -> DescribeAccountOverviewResponseTypeDef: # (1)
...
# describe_account_overview method usage example with argument unpacking
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 session.client("devops-guru").describe_anomaly
method.
boto3 documentation
# describe_anomaly method definition
await def describe_anomaly(
self,
*,
Id: str,
AccountId: str = ...,
) -> DescribeAnomalyResponseTypeDef: # (1)
...
# describe_anomaly method usage example with argument unpacking
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 session.client("devops-guru").describe_event_sources_config
method.
boto3 documentation
# describe_event_sources_config method definition
await 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 session.client("devops-guru").describe_feedback
method.
boto3 documentation
# describe_feedback method definition
await def describe_feedback(
self,
*,
InsightId: str = ...,
) -> DescribeFeedbackResponseTypeDef: # (1)
...
# describe_feedback method usage example with argument unpacking
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 session.client("devops-guru").describe_insight
method.
boto3 documentation
# describe_insight method definition
await def describe_insight(
self,
*,
Id: str,
AccountId: str = ...,
) -> DescribeInsightResponseTypeDef: # (1)
...
# describe_insight method usage example with argument unpacking
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 session.client("devops-guru").describe_organization_health
method.
boto3 documentation
# describe_organization_health method definition
await def describe_organization_health(
self,
*,
AccountIds: Sequence[str] = ...,
OrganizationalUnitIds: Sequence[str] = ...,
) -> DescribeOrganizationHealthResponseTypeDef: # (1)
...
# describe_organization_health method usage example with argument unpacking
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 session.client("devops-guru").describe_organization_overview
method.
boto3 documentation
# describe_organization_overview method definition
await def describe_organization_overview(
self,
*,
FromTime: Union[datetime, str],
ToTime: Union[datetime, str] = ...,
AccountIds: Sequence[str] = ...,
OrganizationalUnitIds: Sequence[str] = ...,
) -> DescribeOrganizationOverviewResponseTypeDef: # (1)
...
# describe_organization_overview method usage example with argument unpacking
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 session.client("devops-guru").describe_organization_resource_collection_health
method.
boto3 documentation
# describe_organization_resource_collection_health method definition
await 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
# describe_organization_resource_collection_health method usage example with argument unpacking
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 session.client("devops-guru").describe_resource_collection_health
method.
boto3 documentation
# describe_resource_collection_health method definition
await def describe_resource_collection_health(
self,
*,
ResourceCollectionType: ResourceCollectionTypeType, # (1)
NextToken: str = ...,
) -> DescribeResourceCollectionHealthResponseTypeDef: # (2)
...
# describe_resource_collection_health method usage example with argument unpacking
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 session.client("devops-guru").describe_service_integration
method.
boto3 documentation
# describe_service_integration method definition
await 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 session.client("devops-guru").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.client("devops-guru").get_cost_estimation
method.
boto3 documentation
# get_cost_estimation method definition
await def get_cost_estimation(
self,
*,
NextToken: str = ...,
) -> GetCostEstimationResponseTypeDef: # (1)
...
# get_cost_estimation method usage example with argument unpacking
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 session.client("devops-guru").get_resource_collection
method.
boto3 documentation
# get_resource_collection method definition
await def get_resource_collection(
self,
*,
ResourceCollectionType: ResourceCollectionTypeType, # (1)
NextToken: str = ...,
) -> GetResourceCollectionResponseTypeDef: # (2)
...
# get_resource_collection method usage example with argument unpacking
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 session.client("devops-guru").list_anomalies_for_insight
method.
boto3 documentation
# list_anomalies_for_insight method definition
await 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
# list_anomalies_for_insight method usage example with argument unpacking
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 session.client("devops-guru").list_anomalous_log_groups
method.
boto3 documentation
# list_anomalous_log_groups method definition
await def list_anomalous_log_groups(
self,
*,
InsightId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAnomalousLogGroupsResponseTypeDef: # (1)
...
# list_anomalous_log_groups method usage example with argument unpacking
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 session.client("devops-guru").list_events
method.
boto3 documentation
# list_events method definition
await def list_events(
self,
*,
Filters: ListEventsFiltersTypeDef, # (1)
MaxResults: int = ...,
NextToken: str = ...,
AccountId: str = ...,
) -> ListEventsResponseTypeDef: # (2)
...
# list_events method usage example with argument unpacking
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 session.client("devops-guru").list_insights
method.
boto3 documentation
# list_insights method definition
await def list_insights(
self,
*,
StatusFilter: ListInsightsStatusFilterTypeDef, # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListInsightsResponseTypeDef: # (2)
...
# list_insights method usage example with argument unpacking
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 session.client("devops-guru").list_monitored_resources
method.
boto3 documentation
# list_monitored_resources method definition
await def list_monitored_resources(
self,
*,
Filters: ListMonitoredResourcesFiltersTypeDef = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListMonitoredResourcesResponseTypeDef: # (2)
...
# list_monitored_resources method usage example with argument unpacking
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 session.client("devops-guru").list_notification_channels
method.
boto3 documentation
# list_notification_channels method definition
await def list_notification_channels(
self,
*,
NextToken: str = ...,
) -> ListNotificationChannelsResponseTypeDef: # (1)
...
# list_notification_channels method usage example with argument unpacking
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 session.client("devops-guru").list_organization_insights
method.
boto3 documentation
# list_organization_insights method definition
await def list_organization_insights(
self,
*,
StatusFilter: ListInsightsStatusFilterTypeDef, # (1)
MaxResults: int = ...,
AccountIds: Sequence[str] = ...,
OrganizationalUnitIds: Sequence[str] = ...,
NextToken: str = ...,
) -> ListOrganizationInsightsResponseTypeDef: # (2)
...
# list_organization_insights method usage example with argument unpacking
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 session.client("devops-guru").list_recommendations
method.
boto3 documentation
# list_recommendations method definition
await def list_recommendations(
self,
*,
InsightId: str,
NextToken: str = ...,
Locale: LocaleType = ..., # (1)
AccountId: str = ...,
) -> ListRecommendationsResponseTypeDef: # (2)
...
# list_recommendations method usage example with argument unpacking
kwargs: ListRecommendationsRequestRequestTypeDef = { # (1)
"InsightId": ...,
}
parent.list_recommendations(**kwargs)
put_feedback#
Collects customer feedback about the specified insight.
Type annotations and code completion for session.client("devops-guru").put_feedback
method.
boto3 documentation
# put_feedback method definition
await def put_feedback(
self,
*,
InsightFeedback: InsightFeedbackTypeDef = ..., # (1)
) -> Dict[str, Any]:
...
# put_feedback method usage example with argument unpacking
kwargs: PutFeedbackRequestRequestTypeDef = { # (1)
"InsightFeedback": ...,
}
parent.put_feedback(**kwargs)
remove_notification_channel#
Removes a notification channel from DevOps Guru.
Type annotations and code completion for session.client("devops-guru").remove_notification_channel
method.
boto3 documentation
# remove_notification_channel method definition
await def remove_notification_channel(
self,
*,
Id: str,
) -> Dict[str, Any]:
...
# remove_notification_channel method usage example with argument unpacking
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 session.client("devops-guru").search_insights
method.
boto3 documentation
# search_insights method definition
await 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
# search_insights method usage example with argument unpacking
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 session.client("devops-guru").search_organization_insights
method.
boto3 documentation
# search_organization_insights method definition
await 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
# search_organization_insights method usage example with argument unpacking
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 session.client("devops-guru").start_cost_estimation
method.
boto3 documentation
# start_cost_estimation method definition
await def start_cost_estimation(
self,
*,
ResourceCollection: CostEstimationResourceCollectionFilterTypeDef, # (1)
ClientToken: str = ...,
) -> Dict[str, Any]:
...
# start_cost_estimation method usage example with argument unpacking
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 session.client("devops-guru").update_event_sources_config
method.
boto3 documentation
# update_event_sources_config method definition
await def update_event_sources_config(
self,
*,
EventSources: EventSourcesConfigTypeDef = ..., # (1)
) -> Dict[str, Any]:
...
# update_event_sources_config method usage example with argument unpacking
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 session.client("devops-guru").update_resource_collection
method.
boto3 documentation
# update_resource_collection method definition
await def update_resource_collection(
self,
*,
Action: UpdateResourceCollectionActionType, # (1)
ResourceCollection: UpdateResourceCollectionFilterTypeDef, # (2)
) -> Dict[str, Any]:
...
# update_resource_collection method usage example with argument unpacking
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 session.client("devops-guru").update_service_integration
method.
boto3 documentation
# update_service_integration method definition
await def update_service_integration(
self,
*,
ServiceIntegration: UpdateServiceIntegrationConfigTypeDef, # (1)
) -> Dict[str, Any]:
...
# update_service_integration method usage example with argument unpacking
kwargs: UpdateServiceIntegrationRequestRequestTypeDef = { # (1)
"ServiceIntegration": ...,
}
parent.update_service_integration(**kwargs)
__aenter__#
Type annotations and code completion for session.client("devops-guru").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> DevOpsGuruClient:
...
__aexit__#
Type annotations and code completion for session.client("devops-guru").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.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