com.amazonaws.services.applicationinsights

Class AmazonApplicationInsightsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.applicationinsights.AmazonApplicationInsightsClient

All Implemented Interfaces:

AmazonApplicationInsights

Direct Known Subclasses:

AmazonApplicationInsightsAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonApplicationInsightsClient
extends AmazonWebServiceClient
implements AmazonApplicationInsights

Client for accessing Application Insights. All service calls made using this client are blocking, and will not return until the service call completes.

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
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.applicationinsights.AmazonApplicationInsights

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonApplicationInsightsClientBuilder	builder()
CreateApplicationResult	createApplication(CreateApplicationRequest request) Adds an application that is created from a resource group.
CreateComponentResult	createComponent(CreateComponentRequest request) Creates a custom component by grouping similar standalone instances to monitor.
CreateLogPatternResult	createLogPattern(CreateLogPatternRequest request) Adds an log pattern to a LogPatternSet.
DeleteApplicationResult	deleteApplication(DeleteApplicationRequest request) Removes the specified application from monitoring.
DeleteComponentResult	deleteComponent(DeleteComponentRequest request) Ungroups a custom component.
DeleteLogPatternResult	deleteLogPattern(DeleteLogPatternRequest request) Removes the specified log pattern from a LogPatternSet.
DescribeApplicationResult	describeApplication(DescribeApplicationRequest request) Describes the application.
DescribeComponentResult	describeComponent(DescribeComponentRequest request) Describes a component and lists the resources that are grouped together in a component.
DescribeComponentConfigurationResult	describeComponentConfiguration(DescribeComponentConfigurationRequest request) Describes the monitoring configuration of the component.
DescribeComponentConfigurationRecommendationResult	describeComponentConfigurationRecommendation(DescribeComponentConfigurationRecommendationRequest request) Describes the recommended monitoring configuration of the component.
DescribeLogPatternResult	describeLogPattern(DescribeLogPatternRequest request) Describe a specific log pattern from a LogPatternSet.
DescribeObservationResult	describeObservation(DescribeObservationRequest request) Describes an anomaly or error with the application.
DescribeProblemResult	describeProblem(DescribeProblemRequest request) Describes an application problem.
DescribeProblemObservationsResult	describeProblemObservations(DescribeProblemObservationsRequest request) Describes the anomalies or errors associated with the problem.
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 request) Lists the IDs of the applications that you are monitoring.
ListComponentsResult	listComponents(ListComponentsRequest request) Lists the auto-grouped, standalone, and custom components of the application.
ListConfigurationHistoryResult	listConfigurationHistory(ListConfigurationHistoryRequest request) Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights.
ListLogPatternsResult	listLogPatterns(ListLogPatternsRequest request) Lists the log patterns in the specific log LogPatternSet.
ListLogPatternSetsResult	listLogPatternSets(ListLogPatternSetsRequest request) Lists the log pattern sets in the specific application.
ListProblemsResult	listProblems(ListProblemsRequest request) Lists the problems with your application.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Retrieve a list of the tags (keys and values) that are associated with a specified application.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Add one or more tags (keys and values) to a specified application.
UntagResourceResult	untagResource(UntagResourceRequest request) Remove one or more tags (keys and values) from a specified application.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest request) Updates the application.
UpdateComponentResult	updateComponent(UpdateComponentRequest request) Updates the custom component name and/or the list of resources that make up the component.
UpdateComponentConfigurationResult	updateComponentConfiguration(UpdateComponentConfigurationRequest request) Updates the monitoring configurations for the component.
UpdateLogPatternResult	updateLogPattern(UpdateLogPatternRequest request) Adds a log pattern to a LogPatternSet.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonApplicationInsightsClientBuilder builder()

createApplication

public CreateApplicationResult createApplication(CreateApplicationRequest request)

Adds an application that is created from a resource group.

Specified by:

createApplication in interface AmazonApplicationInsights

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

public CreateComponentResult createComponent(CreateComponentRequest request)

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

Specified by:

createComponent in interface AmazonApplicationInsights

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

public CreateLogPatternResult createLogPattern(CreateLogPatternRequest request)

Adds an log pattern to a LogPatternSet.

Specified by:

createLogPattern in interface AmazonApplicationInsights

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

public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)

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

Specified by:

deleteApplication in interface AmazonApplicationInsights

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

public DeleteComponentResult deleteComponent(DeleteComponentRequest request)

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.

Specified by:

deleteComponent in interface AmazonApplicationInsights

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

public DeleteLogPatternResult deleteLogPattern(DeleteLogPatternRequest request)

Removes the specified log pattern from a LogPatternSet.

Specified by:

deleteLogPattern in interface AmazonApplicationInsights

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

public DescribeApplicationResult describeApplication(DescribeApplicationRequest request)

Describes the application.

Specified by:

describeApplication in interface AmazonApplicationInsights

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

public DescribeComponentResult describeComponent(DescribeComponentRequest request)

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

Specified by:

describeComponent in interface AmazonApplicationInsights

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

public DescribeComponentConfigurationResult describeComponentConfiguration(DescribeComponentConfigurationRequest request)

Describes the monitoring configuration of the component.

Specified by:

describeComponentConfiguration in interface AmazonApplicationInsights

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

public DescribeComponentConfigurationRecommendationResult describeComponentConfigurationRecommendation(DescribeComponentConfigurationRecommendationRequest request)

Describes the recommended monitoring configuration of the component.

Specified by:

describeComponentConfigurationRecommendation in interface AmazonApplicationInsights

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

public DescribeLogPatternResult describeLogPattern(DescribeLogPatternRequest request)

Describe a specific log pattern from a LogPatternSet.

Specified by:

describeLogPattern in interface AmazonApplicationInsights

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

public DescribeObservationResult describeObservation(DescribeObservationRequest request)

Describes an anomaly or error with the application.

Specified by:

describeObservation in interface AmazonApplicationInsights

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

public DescribeProblemResult describeProblem(DescribeProblemRequest request)

Describes an application problem.

Specified by:

describeProblem in interface AmazonApplicationInsights

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

public DescribeProblemObservationsResult describeProblemObservations(DescribeProblemObservationsRequest request)

Describes the anomalies or errors associated with the problem.

Specified by:

describeProblemObservations in interface AmazonApplicationInsights

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

listApplications

public ListApplicationsResult listApplications(ListApplicationsRequest request)

Lists the IDs of the applications that you are monitoring.

Specified by:

listApplications in interface AmazonApplicationInsights

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

public ListComponentsResult listComponents(ListComponentsRequest request)

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

Specified by:

listComponents in interface AmazonApplicationInsights

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

public ListConfigurationHistoryResult listConfigurationHistory(ListConfigurationHistoryRequest request)

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.

Specified by:

listConfigurationHistory in interface AmazonApplicationInsights

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

public ListLogPatternSetsResult listLogPatternSets(ListLogPatternSetsRequest request)

Lists the log pattern sets in the specific application.

Specified by:

listLogPatternSets in interface AmazonApplicationInsights

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

public ListLogPatternsResult listLogPatterns(ListLogPatternsRequest request)

Lists the log patterns in the specific log LogPatternSet.

Specified by:

listLogPatterns in interface AmazonApplicationInsights

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

public ListProblemsResult listProblems(ListProblemsRequest request)

Lists the problems with your application.

Specified by:

listProblems in interface AmazonApplicationInsights

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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.

Specified by:

listTagsForResource in interface AmazonApplicationInsights

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

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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.

Specified by:

tagResource in interface AmazonApplicationInsights

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

public UntagResourceResult untagResource(UntagResourceRequest request)

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

Specified by:

untagResource in interface AmazonApplicationInsights

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

public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)

Updates the application.

Specified by:

updateApplication in interface AmazonApplicationInsights

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

public UpdateComponentResult updateComponent(UpdateComponentRequest request)

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

Specified by:

updateComponent in interface AmazonApplicationInsights

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

public UpdateComponentConfigurationResult updateComponentConfiguration(UpdateComponentConfigurationRequest request)

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.

Specified by:

updateComponentConfiguration in interface AmazonApplicationInsights

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

public UpdateLogPatternResult updateLogPattern(UpdateLogPatternRequest request)

Adds a log pattern to a LogPatternSet.

Specified by:

updateLogPattern in interface AmazonApplicationInsights

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonApplicationInsights

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from interface: AmazonApplicationInsights

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.

Specified by:

shutdown in interface AmazonApplicationInsights

Overrides:

shutdown in class AmazonWebServiceClient