Devops Guru

This page documents function available when using the Devops_Guru module, created with @service Devops_Guru.

Index

Documentation

Main.Devops_Guru.add_notification_channelMethod
add_notification_channel(config)
add_notification_channel(config, params::Dict{String,<:Any})

Adds a notification channel to DevOps Guru. A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated. If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for cross account Amazon SNS topics. If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics. If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.

Arguments

  • config: A NotificationChannelConfig object that specifies what type of notification channel to add. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).
source
Main.Devops_Guru.delete_insightMethod
delete_insight(id)
delete_insight(id, params::Dict{String,<:Any})

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

Arguments

  • id: The ID of the insight.
source
Main.Devops_Guru.describe_account_healthMethod
describe_account_health()
describe_account_health(params::Dict{String,<:Any})

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. Use these numbers to gauge the health of operations in your Amazon Web Services account.

source
Main.Devops_Guru.describe_account_overviewMethod
describe_account_overview(from_time)
describe_account_overview(from_time, params::Dict{String,<:Any})

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.

Arguments

  • from_time: The start of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred after this day.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ToTime": The end of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred before this day. If this is not specified, then the current day is used.
source
Main.Devops_Guru.describe_anomalyMethod
describe_anomaly(id)
describe_anomaly(id, params::Dict{String,<:Any})

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

Arguments

  • id: The ID of the anomaly.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AccountId": The ID of the member account.
source
Main.Devops_Guru.describe_event_sources_configMethod
describe_event_sources_config()
describe_event_sources_config(params::Dict{String,<:Any})

Returns the integration status of services that are integrated with DevOps Guru as Consumer via EventBridge. The one service that can be integrated with DevOps Guru is Amazon CodeGuru Profiler, which can produce proactive recommendations which can be stored and viewed in DevOps Guru.

source
Main.Devops_Guru.describe_feedbackMethod
describe_feedback()
describe_feedback(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "InsightId": The ID of the insight for which the feedback was provided.
source
Main.Devops_Guru.describe_insightMethod
describe_insight(id)
describe_insight(id, params::Dict{String,<:Any})

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

Arguments

  • id: The ID of the insight.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AccountId": The ID of the member account in the organization.
source
Main.Devops_Guru.describe_organization_healthMethod
describe_organization_health()
describe_organization_health(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AccountIds": The ID of the Amazon Web Services account.
  • "OrganizationalUnitIds": The ID of the organizational unit.
source
Main.Devops_Guru.describe_organization_overviewMethod
describe_organization_overview(from_time)
describe_organization_overview(from_time, params::Dict{String,<:Any})

Returns an overview of your organization's history based on the specified time range. The overview includes the total reactive and proactive insights.

Arguments

  • from_time: The start of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred after this day.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AccountIds": The ID of the Amazon Web Services account.
  • "OrganizationalUnitIds": The ID of the organizational unit.
  • "ToTime": The end of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred before this day. If this is not specified, then the current day is used.
source
Main.Devops_Guru.describe_organization_resource_collection_healthMethod
describe_organization_resource_collection_health(organization_resource_collection_type)
describe_organization_resource_collection_health(organization_resource_collection_type, params::Dict{String,<:Any})

Provides an overview of your system's health. If additional member accounts are part of your organization, you can filter those accounts using the AccountIds field.

Arguments

  • organization_resource_collection_type: An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AccountIds": The ID of the Amazon Web Services account.
  • "MaxResults": The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  • "NextToken": The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
  • "OrganizationalUnitIds": The ID of the organizational unit.
source
Main.Devops_Guru.describe_resource_collection_healthMethod
describe_resource_collection_health(resource_collection_type)
describe_resource_collection_health(resource_collection_type, params::Dict{String,<:Any})

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. You specify the type of Amazon Web Services resources collection. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

Arguments

  • resource_collection_type: An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
source
Main.Devops_Guru.describe_service_integrationMethod
describe_service_integration()
describe_service_integration(params::Dict{String,<:Any})

Returns the integration status of services that are integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager, which can be used to create an OpsItem for each generated insight.

source
Main.Devops_Guru.get_cost_estimationMethod
get_cost_estimation()
get_cost_estimation(params::Dict{String,<:Any})

Returns an estimate of the monthly cost for DevOps Guru to analyze your Amazon Web Services resources. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
source
Main.Devops_Guru.get_resource_collectionMethod
get_resource_collection(resource_collection_type)
get_resource_collection(resource_collection_type, params::Dict{String,<:Any})

Returns lists Amazon Web Services resources that are of the specified resource collection type. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

Arguments

  • resource_collection_type: The type of Amazon Web Services resource collections to return. The one valid value is CLOUD_FORMATION for Amazon Web Services CloudFormation stacks.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
source
Main.Devops_Guru.list_anomalies_for_insightMethod
list_anomalies_for_insight(insight_id)
list_anomalies_for_insight(insight_id, params::Dict{String,<:Any})

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

Arguments

  • insight_id: The ID of the insight. The returned anomalies belong to this insight.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AccountId": The ID of the Amazon Web Services account.
  • "MaxResults": The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  • "NextToken": The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
  • "StartTimeRange": A time range used to specify when the requested anomalies started. All returned anomalies started during this time range.
source
Main.Devops_Guru.list_anomalous_log_groupsMethod
list_anomalous_log_groups(insight_id)
list_anomalous_log_groups(insight_id, params::Dict{String,<:Any})

Returns the list of log groups that contain log anomalies.

Arguments

  • insight_id: The ID of the insight containing the log groups.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  • "NextToken": The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
source
Main.Devops_Guru.list_eventsMethod
list_events(filters)
list_events(filters, params::Dict{String,<:Any})

Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned.

Arguments

  • filters: A ListEventsFilters object used to specify which events to return.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AccountId": The ID of the Amazon Web Services account.
  • "MaxResults": The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  • "NextToken": The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
source
Main.Devops_Guru.list_insightsMethod
list_insights(status_filter)
list_insights(status_filter, params::Dict{String,<:Any})

Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time and status (ONGOING, CLOSED, or ANY).

Arguments

  • status_filter: A filter used to filter the returned insights by their status. You can specify one status filter.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  • "NextToken": The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
source
Main.Devops_Guru.list_monitored_resourcesMethod
list_monitored_resources()
list_monitored_resources(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": Filters to determine which monitored resources you want to retrieve. You can filter by resource type or resource permission status.
  • "MaxResults": The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  • "NextToken": The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
source
Main.Devops_Guru.list_notification_channelsMethod
list_notification_channels()
list_notification_channels(params::Dict{String,<:Any})

Returns a list of notification channels configured for DevOps Guru. Each notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
source
Main.Devops_Guru.list_organization_insightsMethod
list_organization_insights(status_filter)
list_organization_insights(status_filter, params::Dict{String,<:Any})

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

Arguments

  • status_filter:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AccountIds": The ID of the Amazon Web Services account.
  • "MaxResults": The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  • "NextToken": The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
  • "OrganizationalUnitIds": The ID of the organizational unit.
source
Main.Devops_Guru.list_recommendationsMethod
list_recommendations(insight_id)
list_recommendations(insight_id, params::Dict{String,<:Any})

Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.

Arguments

  • insight_id: The ID of the requested insight.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AccountId": The ID of the Amazon Web Services account.
  • "Locale": A locale that specifies the language to use for recommendations.
  • "NextToken": The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
source
Main.Devops_Guru.put_feedbackMethod
put_feedback()
put_feedback(params::Dict{String,<:Any})

Collects customer feedback about the specified insight.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "InsightFeedback": The feedback from customers is about the recommendations in this insight.
source
Main.Devops_Guru.remove_notification_channelMethod
remove_notification_channel(id)
remove_notification_channel(id, params::Dict{String,<:Any})

Removes a notification channel from DevOps Guru. A notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations.

Arguments

  • id: The ID of the notification channel to be removed.
source
Main.Devops_Guru.search_insightsMethod
search_insights(start_time_range, type)
search_insights(start_time_range, type, params::Dict{String,<:Any})

Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time, one or more statuses (ONGOING or CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE). Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.

Arguments

  • start_time_range: The start of the time range passed in. Returned insights occurred after this time.
  • type: The type of insights you are searching for (REACTIVE or PROACTIVE).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": A SearchInsightsFilters object that is used to set the severity and status filters on your insight search.
  • "MaxResults": The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  • "NextToken": The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
source
Main.Devops_Guru.search_organization_insightsMethod
search_organization_insights(account_ids, start_time_range, type)
search_organization_insights(account_ids, start_time_range, type, params::Dict{String,<:Any})

Returns a list of insights in your organization. You can specify which insights are returned by their start time, one or more statuses (ONGOING, CLOSED, and CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE). Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.

Arguments

  • account_ids: The ID of the Amazon Web Services account.
  • start_time_range:
  • type: The type of insights you are searching for (REACTIVE or PROACTIVE).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": A SearchOrganizationInsightsFilters object that is used to set the severity and status filters on your insight search.
  • "MaxResults": The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  • "NextToken": The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
source
Main.Devops_Guru.start_cost_estimationMethod
start_cost_estimation(resource_collection)
start_cost_estimation(resource_collection, params::Dict{String,<:Any})

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

Arguments

  • resource_collection: The collection of Amazon Web Services resources used to create a monthly DevOps Guru cost estimate.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": The idempotency token used to identify each cost estimate request.
source
Main.Devops_Guru.update_event_sources_configMethod
update_event_sources_config()
update_event_sources_config(params::Dict{String,<:Any})

Enables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon CodeGuru Profiler, which can produce proactive recommendations which can be stored and viewed in DevOps Guru.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EventSources": Configuration information about the integration of DevOps Guru as the Consumer via EventBridge with another AWS Service.
source
Main.Devops_Guru.update_resource_collectionMethod
update_resource_collection(action, resource_collection)
update_resource_collection(action, resource_collection, params::Dict{String,<:Any})

Updates the collection of resources that DevOps Guru analyzes. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks. This method also creates the IAM role required for you to use DevOps Guru.

Arguments

  • action: Specifies if the resource collection in the request is added or deleted to the resource collection.
  • resource_collection:
source
Main.Devops_Guru.update_service_integrationMethod
update_service_integration(service_integration)
update_service_integration(service_integration, params::Dict{String,<:Any})

Enables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager, which can be used to create an OpsItem for each generated insight.

Arguments

  • service_integration: An IntegratedServiceConfig object used to specify the integrated service you want to update, and whether you want to update it to enabled or disabled.
source