AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing ApplicationInsights Amazon CloudWatch Application Insights for .NET and SQL Server

Amazon CloudWatch Application Insights for .NET and SQL Server is a service that helps you detect common problems with your .NET and SQL Server-based applications. It enables you to pinpoint the source of issues in your applications (built with technologies such as Microsoft IIS, .NET, and Microsoft SQL Server), by providing key insights into detected problems.

After you onboard your application, CloudWatch Application Insights for .NET and SQL Server identifies, recommends, and sets up metrics and logs. It continuously analyzes and correlates your metrics and logs for unusual behavior to surface actionable problems with your application. For example, if your application is slow and unresponsive and leading to HTTP 500 errors in your Application Load Balancer (ALB), Application Insights informs you that a memory pressure problem with your SQL Server database is occurring. It bases this analysis on impactful metrics and log errors.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.ApplicationInsights.AmazonApplicationInsightsClient

Namespace: Amazon.ApplicationInsights
Assembly: AWSSDK.ApplicationInsights.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonApplicationInsightsClient : AmazonServiceClient
         IAmazonApplicationInsights, IAmazonService, IDisposable

The AmazonApplicationInsightsClient type exposes the following members

Constructors

NameDescription
Public Method AmazonApplicationInsightsClient()

Constructs AmazonApplicationInsightsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonApplicationInsightsClient(RegionEndpoint)

Constructs AmazonApplicationInsightsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonApplicationInsightsClient(AmazonApplicationInsightsConfig)

Constructs AmazonApplicationInsightsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonApplicationInsightsClient(AWSCredentials)

Constructs AmazonApplicationInsightsClient with AWS Credentials

Public Method AmazonApplicationInsightsClient(AWSCredentials, RegionEndpoint)

Constructs AmazonApplicationInsightsClient with AWS Credentials

Public Method AmazonApplicationInsightsClient(AWSCredentials, AmazonApplicationInsightsConfig)

Constructs AmazonApplicationInsightsClient with AWS Credentials and an AmazonApplicationInsightsClient Configuration object.

Public Method AmazonApplicationInsightsClient(string, string)

Constructs AmazonApplicationInsightsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonApplicationInsightsClient(string, string, RegionEndpoint)

Constructs AmazonApplicationInsightsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonApplicationInsightsClient(string, string, AmazonApplicationInsightsConfig)

Constructs AmazonApplicationInsightsClient with AWS Access Key ID, AWS Secret Key and an AmazonApplicationInsightsClient Configuration object.

Public Method AmazonApplicationInsightsClient(string, string, string)

Constructs AmazonApplicationInsightsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonApplicationInsightsClient(string, string, string, RegionEndpoint)

Constructs AmazonApplicationInsightsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonApplicationInsightsClient(string, string, string, AmazonApplicationInsightsConfig)

Constructs AmazonApplicationInsightsClient with AWS Access Key ID, AWS Secret Key and an AmazonApplicationInsightsClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateApplication(CreateApplicationRequest)

Adds an application that is created from a resource group.

Public Method CreateApplicationAsync(CreateApplicationRequest, CancellationToken)

Adds an application that is created from a resource group.

Public Method CreateComponent(CreateComponentRequest)

Creates a custom component by grouping similar standalone instances to monitor.

Public Method CreateComponentAsync(CreateComponentRequest, CancellationToken)

Creates a custom component by grouping similar standalone instances to monitor.

Public Method CreateLogPattern(CreateLogPatternRequest)

Adds an log pattern to a LogPatternSet.

Public Method CreateLogPatternAsync(CreateLogPatternRequest, CancellationToken)

Adds an log pattern to a LogPatternSet.

Public Method DeleteApplication(DeleteApplicationRequest)

Removes the specified application from monitoring. Does not delete the application.

Public Method DeleteApplicationAsync(DeleteApplicationRequest, CancellationToken)

Removes the specified application from monitoring. Does not delete the application.

Public Method DeleteComponent(DeleteComponentRequest)

Ungroups a custom component. When you ungroup custom components, all applicable monitors that are set up for the component are removed and the instances revert to their standalone status.

Public Method DeleteComponentAsync(DeleteComponentRequest, CancellationToken)

Ungroups a custom component. When you ungroup custom components, all applicable monitors that are set up for the component are removed and the instances revert to their standalone status.

Public Method DeleteLogPattern(DeleteLogPatternRequest)

Removes the specified log pattern from a LogPatternSet.

Public Method DeleteLogPatternAsync(DeleteLogPatternRequest, CancellationToken)

Removes the specified log pattern from a LogPatternSet.

Public Method DescribeApplication(DescribeApplicationRequest)

Describes the application.

Public Method DescribeApplicationAsync(DescribeApplicationRequest, CancellationToken)

Describes the application.

Public Method DescribeComponent(DescribeComponentRequest)

Describes a component and lists the resources that are grouped together in a component.

Public Method DescribeComponentAsync(DescribeComponentRequest, CancellationToken)

Describes a component and lists the resources that are grouped together in a component.

Public Method DescribeComponentConfiguration(DescribeComponentConfigurationRequest)

Describes the monitoring configuration of the component.

Public Method DescribeComponentConfigurationAsync(DescribeComponentConfigurationRequest, CancellationToken)

Describes the monitoring configuration of the component.

Public Method DescribeComponentConfigurationRecommendation(DescribeComponentConfigurationRecommendationRequest)

Describes the recommended monitoring configuration of the component.

Public Method DescribeComponentConfigurationRecommendationAsync(DescribeComponentConfigurationRecommendationRequest, CancellationToken)

Describes the recommended monitoring configuration of the component.

Public Method DescribeLogPattern(DescribeLogPatternRequest)

Describe a specific log pattern from a LogPatternSet.

Public Method DescribeLogPatternAsync(DescribeLogPatternRequest, CancellationToken)

Describe a specific log pattern from a LogPatternSet.

Public Method DescribeObservation(DescribeObservationRequest)

Describes an anomaly or error with the application.

Public Method DescribeObservationAsync(DescribeObservationRequest, CancellationToken)

Describes an anomaly or error with the application.

Public Method DescribeProblem(DescribeProblemRequest)

Describes an application problem.

Public Method DescribeProblemAsync(DescribeProblemRequest, CancellationToken)

Describes an application problem.

Public Method DescribeProblemObservations(DescribeProblemObservationsRequest)

Describes the anomalies or errors associated with the problem.

Public Method DescribeProblemObservationsAsync(DescribeProblemObservationsRequest, CancellationToken)

Describes the anomalies or errors associated with the problem.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ListApplications(ListApplicationsRequest)

Lists the IDs of the applications that you are monitoring.

Public Method ListApplicationsAsync(ListApplicationsRequest, CancellationToken)

Lists the IDs of the applications that you are monitoring.

Public Method ListComponents(ListComponentsRequest)

Lists the auto-grouped, standalone, and custom components of the application.

Public Method ListComponentsAsync(ListComponentsRequest, CancellationToken)

Lists the auto-grouped, standalone, and custom components of the application.

Public Method ListConfigurationHistory(ListConfigurationHistoryRequest)

Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are:

  • INFO: creating a new alarm or updating an alarm threshold.

  • WARN: alarm not created due to insufficient data points used to predict thresholds.

  • ERROR: alarm not created due to permission errors or exceeding quotas.

Public Method ListConfigurationHistoryAsync(ListConfigurationHistoryRequest, CancellationToken)

Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are:

  • INFO: creating a new alarm or updating an alarm threshold.

  • WARN: alarm not created due to insufficient data points used to predict thresholds.

  • ERROR: alarm not created due to permission errors or exceeding quotas.

Public Method ListLogPatterns(ListLogPatternsRequest)

Lists the log patterns in the specific log LogPatternSet.

Public Method ListLogPatternsAsync(ListLogPatternsRequest, CancellationToken)

Lists the log patterns in the specific log LogPatternSet.

Public Method ListLogPatternSets(ListLogPatternSetsRequest)

Lists the log pattern sets in the specific application.

Public Method ListLogPatternSetsAsync(ListLogPatternSetsRequest, CancellationToken)

Lists the log pattern sets in the specific application.

Public Method ListProblems(ListProblemsRequest)

Lists the problems with your application.

Public Method ListProblemsAsync(ListProblemsRequest, CancellationToken)

Lists the problems with your application.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Retrieve a list of the tags (keys and values) that are associated with a specified application. A tag is a label that you optionally define and associate with an application. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Retrieve a list of the tags (keys and values) that are associated with a specified application. A tag is a label that you optionally define and associate with an application. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Public Method TagResource(TagResourceRequest)

Add one or more tags (keys and values) to a specified application. A tag is a label that you optionally define and associate with an application. Tags can help you categorize and manage application in different ways, such as by purpose, owner, environment, or other criteria.

Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Add one or more tags (keys and values) to a specified application. A tag is a label that you optionally define and associate with an application. Tags can help you categorize and manage application in different ways, such as by purpose, owner, environment, or other criteria.

Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Public Method UntagResource(UntagResourceRequest)

Remove one or more tags (keys and values) from a specified application.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Remove one or more tags (keys and values) from a specified application.

Public Method UpdateApplication(UpdateApplicationRequest)

Updates the application.

Public Method UpdateApplicationAsync(UpdateApplicationRequest, CancellationToken)

Updates the application.

Public Method UpdateComponent(UpdateComponentRequest)

Updates the custom component name and/or the list of resources that make up the component.

Public Method UpdateComponentAsync(UpdateComponentRequest, CancellationToken)

Updates the custom component name and/or the list of resources that make up the component.

Public Method UpdateComponentConfiguration(UpdateComponentConfigurationRequest)

Updates the monitoring configurations for the component. The configuration input parameter is an escaped JSON of the configuration and should match the schema of what is returned by DescribeComponentConfigurationRecommendation.

Public Method UpdateComponentConfigurationAsync(UpdateComponentConfigurationRequest, CancellationToken)

Updates the monitoring configurations for the component. The configuration input parameter is an escaped JSON of the configuration and should match the schema of what is returned by DescribeComponentConfigurationRecommendation.

Public Method UpdateLogPattern(UpdateLogPatternRequest)

Adds a log pattern to a LogPatternSet.

Public Method UpdateLogPatternAsync(UpdateLogPatternRequest, CancellationToken)

Adds a log pattern to a LogPatternSet.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms