DevOpsGuru

import { DevOpsGuru } from "https://aws-api.deno.dev/v0.2/services/devopsguru.ts?docs=full";

class DevOpsGuru {

constructor(apiFactory: client.ApiFactory);

async addNotificationChannel(params: AddNotificationChannelRequest, opts?: client.RequestOptions): Promise<AddNotificationChannelResponse>;

async describeAccountHealth(opts?: client.RequestOptions): Promise<DescribeAccountHealthResponse>;

async describeAccountOverview(params: DescribeAccountOverviewRequest, opts?: client.RequestOptions): Promise<DescribeAccountOverviewResponse>;

async describeAnomaly(params: DescribeAnomalyRequest, opts?: client.RequestOptions): Promise<DescribeAnomalyResponse>;

async describeFeedback(params?: DescribeFeedbackRequest, opts?: client.RequestOptions): Promise<DescribeFeedbackResponse>;

async describeInsight(params: DescribeInsightRequest, opts?: client.RequestOptions): Promise<DescribeInsightResponse>;

async describeResourceCollectionHealth(params: DescribeResourceCollectionHealthRequest, opts?: client.RequestOptions): Promise<DescribeResourceCollectionHealthResponse>;

async describeServiceIntegration(opts?: client.RequestOptions): Promise<DescribeServiceIntegrationResponse>;

async getCostEstimation(params?: GetCostEstimationRequest, opts?: client.RequestOptions): Promise<GetCostEstimationResponse>;

async getResourceCollection(params: GetResourceCollectionRequest, opts?: client.RequestOptions): Promise<GetResourceCollectionResponse>;

async listAnomaliesForInsight(params: ListAnomaliesForInsightRequest, opts?: client.RequestOptions): Promise<ListAnomaliesForInsightResponse>;

async listEvents(params: ListEventsRequest, opts?: client.RequestOptions): Promise<ListEventsResponse>;

async listInsights(params: ListInsightsRequest, opts?: client.RequestOptions): Promise<ListInsightsResponse>;

async listNotificationChannels(params?: ListNotificationChannelsRequest, opts?: client.RequestOptions): Promise<ListNotificationChannelsResponse>;

async listRecommendations(params: ListRecommendationsRequest, opts?: client.RequestOptions): Promise<ListRecommendationsResponse>;

async putFeedback(params?: PutFeedbackRequest, opts?: client.RequestOptions): Promise<void>;

async removeNotificationChannel(params: RemoveNotificationChannelRequest, opts?: client.RequestOptions): Promise<void>;

async searchInsights(params: SearchInsightsRequest, opts?: client.RequestOptions): Promise<SearchInsightsResponse>;

async startCostEstimation(params: StartCostEstimationRequest, opts?: client.RequestOptions): Promise<void>;

async updateResourceCollection(params: UpdateResourceCollectionRequest, opts?: client.RequestOptions): Promise<void>;

async updateServiceIntegration(params: UpdateServiceIntegrationRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new DevOpsGuru(apiFactory: client.ApiFactory)

[src]

§Methods

addNotificationChannel(params: AddNotificationChannelRequest, opts?: client.RequestOptions): Promise<AddNotificationChannelResponse>

[src]

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. For more information, see Permissions for cross account Amazon SNS topics.

If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics.

describeAccountHealth(opts?: client.RequestOptions): Promise<DescribeAccountHealthResponse>

[src]

Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your AWS account. Use these numbers to gauge the health of operations in your AWS account.

describeAccountOverview(params: DescribeAccountOverviewRequest, opts?: client.RequestOptions): Promise<DescribeAccountOverviewResponse>

[src]

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.

describeAnomaly(params: DescribeAnomalyRequest, opts?: client.RequestOptions): Promise<DescribeAnomalyResponse>

[src]

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

describeFeedback(params?: DescribeFeedbackRequest, opts?: client.RequestOptions): Promise<DescribeFeedbackResponse>

[src]

Returns the most recent feedback submitted in the current AWS account and Region.

describeInsight(params: DescribeInsightRequest, opts?: client.RequestOptions): Promise<DescribeInsightResponse>

[src]

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

describeResourceCollectionHealth(params: DescribeResourceCollectionHealthRequest, opts?: client.RequestOptions): Promise<DescribeResourceCollectionHealthResponse>

[src]

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 AWS resources collection. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

describeServiceIntegration(opts?: client.RequestOptions): Promise<DescribeServiceIntegrationResponse>

[src]

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

getCostEstimation(params?: GetCostEstimationRequest, opts?: client.RequestOptions): Promise<GetCostEstimationResponse>

[src]

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

getResourceCollection(params: GetResourceCollectionRequest, opts?: client.RequestOptions): Promise<GetResourceCollectionResponse>

[src]

Returns lists AWS resources that are of the specified resource collection type. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

listAnomaliesForInsight(params: ListAnomaliesForInsightRequest, opts?: client.RequestOptions): Promise<ListAnomaliesForInsightResponse>

[src]

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

listEvents(params: ListEventsRequest, opts?: client.RequestOptions): Promise<ListEventsResponse>

[src]

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.

listInsights(params: ListInsightsRequest, opts?: client.RequestOptions): Promise<ListInsightsResponse>

[src]

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

listNotificationChannels(params?: ListNotificationChannelsRequest, opts?: client.RequestOptions): Promise<ListNotificationChannelsResponse>

[src]

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).

listRecommendations(params: ListRecommendationsRequest, opts?: client.RequestOptions): Promise<ListRecommendationsResponse>

[src]

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

putFeedback(params?: PutFeedbackRequest, opts?: client.RequestOptions): Promise<void>

[src]

Collects customer feedback about the specified insight.

removeNotificationChannel(params: RemoveNotificationChannelRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

searchInsights(params: SearchInsightsRequest, opts?: client.RequestOptions): Promise<SearchInsightsResponse>

[src]

Returns a list of insights in your AWS account. 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.

startCostEstimation(params: StartCostEstimationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Starts the creation of an estimate of the monthly cost to analyze your AWS resources.

updateResourceCollection(params: UpdateResourceCollectionRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the collection of resources that DevOps Guru analyzes. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks. This method also creates the IAM role required for you to use DevOps Guru.

updateServiceIntegration(params: UpdateServiceIntegrationRequest, opts?: client.RequestOptions): Promise<void>

[src]

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 AWS Systems Manager, which can be used to create an OpsItem for each generated insight.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]