com.amazonaws.services.applicationinsights

Interface AmazonApplicationInsights

All Known Subinterfaces:

AmazonApplicationInsightsAsync

All Known Implementing Classes:

AbstractAmazonApplicationInsights, AbstractAmazonApplicationInsightsAsync, AmazonApplicationInsightsAsyncClient, AmazonApplicationInsightsClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonApplicationInsights

Interface for accessing Application Insights.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonApplicationInsights instead.

Amazon CloudWatch Application Insights

Amazon CloudWatch Application Insights is a service that helps you detect common problems with your 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 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AddWorkloadResult	addWorkload(AddWorkloadRequest addWorkloadRequest) Adds a workload to a component.
CreateApplicationResult	createApplication(CreateApplicationRequest createApplicationRequest) Adds an application that is created from a resource group.
CreateComponentResult	createComponent(CreateComponentRequest createComponentRequest) Creates a custom component by grouping similar standalone instances to monitor.
CreateLogPatternResult	createLogPattern(CreateLogPatternRequest createLogPatternRequest) Adds an log pattern to a LogPatternSet.
DeleteApplicationResult	deleteApplication(DeleteApplicationRequest deleteApplicationRequest) Removes the specified application from monitoring.
DeleteComponentResult	deleteComponent(DeleteComponentRequest deleteComponentRequest) Ungroups a custom component.
DeleteLogPatternResult	deleteLogPattern(DeleteLogPatternRequest deleteLogPatternRequest) Removes the specified log pattern from a LogPatternSet.
DescribeApplicationResult	describeApplication(DescribeApplicationRequest describeApplicationRequest) Describes the application.
DescribeComponentResult	describeComponent(DescribeComponentRequest describeComponentRequest) Describes a component and lists the resources that are grouped together in a component.
DescribeComponentConfigurationResult	describeComponentConfiguration(DescribeComponentConfigurationRequest describeComponentConfigurationRequest) Describes the monitoring configuration of the component.
DescribeComponentConfigurationRecommendationResult	describeComponentConfigurationRecommendation(DescribeComponentConfigurationRecommendationRequest describeComponentConfigurationRecommendationRequest) Describes the recommended monitoring configuration of the component.
DescribeLogPatternResult	describeLogPattern(DescribeLogPatternRequest describeLogPatternRequest) Describe a specific log pattern from a LogPatternSet.
DescribeObservationResult	describeObservation(DescribeObservationRequest describeObservationRequest) Describes an anomaly or error with the application.
DescribeProblemResult	describeProblem(DescribeProblemRequest describeProblemRequest) Describes an application problem.
DescribeProblemObservationsResult	describeProblemObservations(DescribeProblemObservationsRequest describeProblemObservationsRequest) Describes the anomalies or errors associated with the problem.
DescribeWorkloadResult	describeWorkload(DescribeWorkloadRequest describeWorkloadRequest) Describes a workload and its configuration.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
ListApplicationsResult	listApplications(ListApplicationsRequest listApplicationsRequest) Lists the IDs of the applications that you are monitoring.
ListComponentsResult	listComponents(ListComponentsRequest listComponentsRequest) Lists the auto-grouped, standalone, and custom components of the application.
ListConfigurationHistoryResult	listConfigurationHistory(ListConfigurationHistoryRequest listConfigurationHistoryRequest) Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights.
ListLogPatternsResult	listLogPatterns(ListLogPatternsRequest listLogPatternsRequest) Lists the log patterns in the specific log LogPatternSet.
ListLogPatternSetsResult	listLogPatternSets(ListLogPatternSetsRequest listLogPatternSetsRequest) Lists the log pattern sets in the specific application.
ListProblemsResult	listProblems(ListProblemsRequest listProblemsRequest) Lists the problems with your application.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieve a list of the tags (keys and values) that are associated with a specified application.
ListWorkloadsResult	listWorkloads(ListWorkloadsRequest listWorkloadsRequest) Lists the workloads that are configured on a given component.
RemoveWorkloadResult	removeWorkload(RemoveWorkloadRequest removeWorkloadRequest) Remove workload from a component.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Add one or more tags (keys and values) to a specified application.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Remove one or more tags (keys and values) from a specified application.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest updateApplicationRequest) Updates the application.
UpdateComponentResult	updateComponent(UpdateComponentRequest updateComponentRequest) Updates the custom component name and/or the list of resources that make up the component.
UpdateComponentConfigurationResult	updateComponentConfiguration(UpdateComponentConfigurationRequest updateComponentConfigurationRequest) Updates the monitoring configurations for the component.
UpdateLogPatternResult	updateLogPattern(UpdateLogPatternRequest updateLogPatternRequest) Adds a log pattern to a LogPatternSet.
UpdateProblemResult	updateProblem(UpdateProblemRequest updateProblemRequest) Updates the visibility of the problem or specifies the problem as RESOLVED.
UpdateWorkloadResult	updateWorkload(UpdateWorkloadRequest updateWorkloadRequest) Adds a workload to a component.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

addWorkload

AddWorkloadResult addWorkload(AddWorkloadRequest addWorkloadRequest)

Adds a workload to a component. Each component can have at most five workloads.

Parameters:

addWorkloadRequest -

Returns:

Result of the AddWorkload operation returned by the service.

Throws:

ResourceInUseException - The resource is already created or in use.

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

createApplication

CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)

Adds an application that is created from a resource group.

Parameters:

createApplicationRequest -

Returns:

Result of the CreateApplication operation returned by the service.

Throws:

ResourceInUseException - The resource is already created or in use.

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

TagsAlreadyExistException - Tags are already registered for the specified application ARN.

AccessDeniedException - User does not have permissions to perform this action.

See Also:

AWS API Documentation

createComponent

CreateComponentResult createComponent(CreateComponentRequest createComponentRequest)

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

Parameters:

createComponentRequest -

Returns:

Result of the CreateComponent operation returned by the service.

Throws:

ResourceInUseException - The resource is already created or in use.

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

createLogPattern

CreateLogPatternResult createLogPattern(CreateLogPatternRequest createLogPatternRequest)

Adds an log pattern to a LogPatternSet.

Parameters:

createLogPatternRequest -

Returns:

Result of the CreateLogPattern operation returned by the service.

Throws:

ResourceInUseException - The resource is already created or in use.

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

deleteApplication

DeleteApplicationResult deleteApplication(DeleteApplicationRequest deleteApplicationRequest)

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

Parameters:

deleteApplicationRequest -

Returns:

Result of the DeleteApplication operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

BadRequestException - The request is not understood by the server.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

deleteComponent

DeleteComponentResult deleteComponent(DeleteComponentRequest 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.

Parameters:

deleteComponentRequest -

Returns:

Result of the DeleteComponent operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

deleteLogPattern

DeleteLogPatternResult deleteLogPattern(DeleteLogPatternRequest deleteLogPatternRequest)

Removes the specified log pattern from a LogPatternSet.

Parameters:

deleteLogPatternRequest -

Returns:

Result of the DeleteLogPattern operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

BadRequestException - The request is not understood by the server.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

describeApplication

DescribeApplicationResult describeApplication(DescribeApplicationRequest describeApplicationRequest)

Describes the application.

Parameters:

describeApplicationRequest -

Returns:

Result of the DescribeApplication operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

describeComponent

DescribeComponentResult describeComponent(DescribeComponentRequest describeComponentRequest)

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

Parameters:

describeComponentRequest -

Returns:

Result of the DescribeComponent operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

describeComponentConfiguration

DescribeComponentConfigurationResult describeComponentConfiguration(DescribeComponentConfigurationRequest describeComponentConfigurationRequest)

Describes the monitoring configuration of the component.

Parameters:

describeComponentConfigurationRequest -

Returns:

Result of the DescribeComponentConfiguration operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

describeComponentConfigurationRecommendation

DescribeComponentConfigurationRecommendationResult describeComponentConfigurationRecommendation(DescribeComponentConfigurationRecommendationRequest describeComponentConfigurationRecommendationRequest)

Describes the recommended monitoring configuration of the component.

Parameters:

describeComponentConfigurationRecommendationRequest -

Returns:

Result of the DescribeComponentConfigurationRecommendation operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

describeLogPattern

DescribeLogPatternResult describeLogPattern(DescribeLogPatternRequest describeLogPatternRequest)

Describe a specific log pattern from a LogPatternSet.

Parameters:

describeLogPatternRequest -

Returns:

Result of the DescribeLogPattern operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

describeObservation

DescribeObservationResult describeObservation(DescribeObservationRequest describeObservationRequest)

Describes an anomaly or error with the application.

Parameters:

describeObservationRequest -

Returns:

Result of the DescribeObservation operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The parameter is not valid.

ResourceNotFoundException - The resource does not exist in the customer account.

See Also:

AWS API Documentation

describeProblem

DescribeProblemResult describeProblem(DescribeProblemRequest describeProblemRequest)

Describes an application problem.

Parameters:

describeProblemRequest -

Returns:

Result of the DescribeProblem operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The parameter is not valid.

ResourceNotFoundException - The resource does not exist in the customer account.

See Also:

AWS API Documentation

describeProblemObservations

DescribeProblemObservationsResult describeProblemObservations(DescribeProblemObservationsRequest describeProblemObservationsRequest)

Describes the anomalies or errors associated with the problem.

Parameters:

describeProblemObservationsRequest -

Returns:

Result of the DescribeProblemObservations operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The parameter is not valid.

ResourceNotFoundException - The resource does not exist in the customer account.

See Also:

AWS API Documentation

describeWorkload

DescribeWorkloadResult describeWorkload(DescribeWorkloadRequest describeWorkloadRequest)

Describes a workload and its configuration.

Parameters:

describeWorkloadRequest -

Returns:

Result of the DescribeWorkload operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

listApplications

ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)

Lists the IDs of the applications that you are monitoring.

Parameters:

listApplicationsRequest -

Returns:

Result of the ListApplications operation returned by the service.

Throws:

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

listComponents

ListComponentsResult listComponents(ListComponentsRequest listComponentsRequest)

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

Parameters:

listComponentsRequest -

Returns:

Result of the ListComponents operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

listConfigurationHistory

ListConfigurationHistoryResult listConfigurationHistory(ListConfigurationHistoryRequest 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.

Parameters:

listConfigurationHistoryRequest -

Returns:

Result of the ListConfigurationHistory operation returned by the service.

Throws:

ValidationException - The parameter is not valid.

ResourceNotFoundException - The resource does not exist in the customer account.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

listLogPatternSets

ListLogPatternSetsResult listLogPatternSets(ListLogPatternSetsRequest listLogPatternSetsRequest)

Lists the log pattern sets in the specific application.

Parameters:

listLogPatternSetsRequest -

Returns:

Result of the ListLogPatternSets operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

listLogPatterns

ListLogPatternsResult listLogPatterns(ListLogPatternsRequest listLogPatternsRequest)

Lists the log patterns in the specific log LogPatternSet.

Parameters:

listLogPatternsRequest -

Returns:

Result of the ListLogPatterns operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

listProblems

ListProblemsResult listProblems(ListProblemsRequest listProblemsRequest)

Lists the problems with your application.

Parameters:

listProblemsRequest -

Returns:

Result of the ListProblems operation returned by the service.

Throws:

ValidationException - The parameter is not valid.

ResourceNotFoundException - The resource does not exist in the customer account.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest 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.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

See Also:

AWS API Documentation

listWorkloads

ListWorkloadsResult listWorkloads(ListWorkloadsRequest listWorkloadsRequest)

Lists the workloads that are configured on a given component.

Parameters:

listWorkloadsRequest -

Returns:

Result of the ListWorkloads operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

removeWorkload

RemoveWorkloadResult removeWorkload(RemoveWorkloadRequest removeWorkloadRequest)

Remove workload from a component.

Parameters:

removeWorkloadRequest -

Returns:

Result of the RemoveWorkload operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest 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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

TooManyTagsException - The number of the provided tags is beyond the limit, or the number of total tags you are trying to attach to the specified resource exceeds the limit.

ValidationException - The parameter is not valid.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

See Also:

AWS API Documentation

updateApplication

UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)

Updates the application.

Parameters:

updateApplicationRequest -

Returns:

Result of the UpdateApplication operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

See Also:

AWS API Documentation

updateComponent

UpdateComponentResult updateComponent(UpdateComponentRequest updateComponentRequest)

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

Parameters:

updateComponentRequest -

Returns:

Result of the UpdateComponent operation returned by the service.

Throws:

ResourceInUseException - The resource is already created or in use.

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

updateComponentConfiguration

UpdateComponentConfigurationResult updateComponentConfiguration(UpdateComponentConfigurationRequest 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.

Parameters:

updateComponentConfigurationRequest -

Returns:

Result of the UpdateComponentConfiguration operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

updateLogPattern

UpdateLogPatternResult updateLogPattern(UpdateLogPatternRequest updateLogPatternRequest)

Adds a log pattern to a LogPatternSet.

Parameters:

updateLogPatternRequest -

Returns:

Result of the UpdateLogPattern operation returned by the service.

Throws:

ResourceInUseException - The resource is already created or in use.

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

updateProblem

UpdateProblemResult updateProblem(UpdateProblemRequest updateProblemRequest)

Updates the visibility of the problem or specifies the problem as RESOLVED.

Parameters:

updateProblemRequest -

Returns:

Result of the UpdateProblem operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The parameter is not valid.

ResourceNotFoundException - The resource does not exist in the customer account.

See Also:

AWS API Documentation

updateWorkload

UpdateWorkloadResult updateWorkload(UpdateWorkloadRequest updateWorkloadRequest)

Adds a workload to a component. Each component can have at most five workloads.

Parameters:

updateWorkloadRequest -

Returns:

Result of the UpdateWorkload operation returned by the service.

Throws:

ResourceNotFoundException - The resource does not exist in the customer account.

ValidationException - The parameter is not valid.

InternalServerException - The server encountered an internal error and is unable to complete the request.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.