@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonApplicationInsightsClient extends AmazonWebServiceClient implements AmazonApplicationInsights
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AddWorkloadResult |
addWorkload(AddWorkloadRequest request)
Adds a workload to a component.
|
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.
|
DescribeWorkloadResult |
describeWorkload(DescribeWorkloadRequest request)
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 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.
|
ListWorkloadsResult |
listWorkloads(ListWorkloadsRequest request)
Lists the workloads that are configured on a given component.
|
RemoveWorkloadResult |
removeWorkload(RemoveWorkloadRequest request)
Remove workload from a component.
|
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 . |
UpdateProblemResult |
updateProblem(UpdateProblemRequest request)
Updates the visibility of the problem or specifies the problem as
RESOLVED . |
UpdateWorkloadResult |
updateWorkload(UpdateWorkloadRequest request)
Adds a workload to a component.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AmazonApplicationInsightsClientBuilder builder()
public AddWorkloadResult addWorkload(AddWorkloadRequest request)
Adds a workload to a component. Each component can have at most five workloads.
addWorkload
in interface AmazonApplicationInsights
addWorkloadRequest
- 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.public CreateApplicationResult createApplication(CreateApplicationRequest request)
Adds an application that is created from a resource group.
createApplication
in interface AmazonApplicationInsights
createApplicationRequest
- 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.public CreateComponentResult createComponent(CreateComponentRequest request)
Creates a custom component by grouping similar standalone instances to monitor.
createComponent
in interface AmazonApplicationInsights
createComponentRequest
- 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.public CreateLogPatternResult createLogPattern(CreateLogPatternRequest request)
Adds an log pattern to a LogPatternSet
.
createLogPattern
in interface AmazonApplicationInsights
createLogPatternRequest
- 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.public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
Removes the specified application from monitoring. Does not delete the application.
deleteApplication
in interface AmazonApplicationInsights
deleteApplicationRequest
- 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.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.
deleteComponent
in interface AmazonApplicationInsights
deleteComponentRequest
- 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.public DeleteLogPatternResult deleteLogPattern(DeleteLogPatternRequest request)
Removes the specified log pattern from a LogPatternSet
.
deleteLogPattern
in interface AmazonApplicationInsights
deleteLogPatternRequest
- 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.public DescribeApplicationResult describeApplication(DescribeApplicationRequest request)
Describes the application.
describeApplication
in interface AmazonApplicationInsights
describeApplicationRequest
- 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.public DescribeComponentResult describeComponent(DescribeComponentRequest request)
Describes a component and lists the resources that are grouped together in a component.
describeComponent
in interface AmazonApplicationInsights
describeComponentRequest
- 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.public DescribeComponentConfigurationResult describeComponentConfiguration(DescribeComponentConfigurationRequest request)
Describes the monitoring configuration of the component.
describeComponentConfiguration
in interface AmazonApplicationInsights
describeComponentConfigurationRequest
- 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.public DescribeComponentConfigurationRecommendationResult describeComponentConfigurationRecommendation(DescribeComponentConfigurationRecommendationRequest request)
Describes the recommended monitoring configuration of the component.
describeComponentConfigurationRecommendation
in interface AmazonApplicationInsights
describeComponentConfigurationRecommendationRequest
- 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.public DescribeLogPatternResult describeLogPattern(DescribeLogPatternRequest request)
Describe a specific log pattern from a LogPatternSet
.
describeLogPattern
in interface AmazonApplicationInsights
describeLogPatternRequest
- 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.public DescribeObservationResult describeObservation(DescribeObservationRequest request)
Describes an anomaly or error with the application.
describeObservation
in interface AmazonApplicationInsights
describeObservationRequest
- 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.public DescribeProblemResult describeProblem(DescribeProblemRequest request)
Describes an application problem.
describeProblem
in interface AmazonApplicationInsights
describeProblemRequest
- 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.public DescribeProblemObservationsResult describeProblemObservations(DescribeProblemObservationsRequest request)
Describes the anomalies or errors associated with the problem.
describeProblemObservations
in interface AmazonApplicationInsights
describeProblemObservationsRequest
- 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.public DescribeWorkloadResult describeWorkload(DescribeWorkloadRequest request)
Describes a workload and its configuration.
describeWorkload
in interface AmazonApplicationInsights
describeWorkloadRequest
- 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.public ListApplicationsResult listApplications(ListApplicationsRequest request)
Lists the IDs of the applications that you are monitoring.
listApplications
in interface AmazonApplicationInsights
listApplicationsRequest
- ValidationException
- The parameter is not valid.InternalServerException
- The server encountered an internal error and is unable to complete the request.public ListComponentsResult listComponents(ListComponentsRequest request)
Lists the auto-grouped, standalone, and custom components of the application.
listComponents
in interface AmazonApplicationInsights
listComponentsRequest
- 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.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.
listConfigurationHistory
in interface AmazonApplicationInsights
listConfigurationHistoryRequest
- 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.public ListLogPatternSetsResult listLogPatternSets(ListLogPatternSetsRequest request)
Lists the log pattern sets in the specific application.
listLogPatternSets
in interface AmazonApplicationInsights
listLogPatternSetsRequest
- 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.public ListLogPatternsResult listLogPatterns(ListLogPatternsRequest request)
Lists the log patterns in the specific log LogPatternSet
.
listLogPatterns
in interface AmazonApplicationInsights
listLogPatternsRequest
- 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.public ListProblemsResult listProblems(ListProblemsRequest request)
Lists the problems with your application.
listProblems
in interface AmazonApplicationInsights
listProblemsRequest
- 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.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.
listTagsForResource
in interface AmazonApplicationInsights
listTagsForResourceRequest
- ResourceNotFoundException
- The resource does not exist in the customer account.ValidationException
- The parameter is not valid.public ListWorkloadsResult listWorkloads(ListWorkloadsRequest request)
Lists the workloads that are configured on a given component.
listWorkloads
in interface AmazonApplicationInsights
listWorkloadsRequest
- 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.public RemoveWorkloadResult removeWorkload(RemoveWorkloadRequest request)
Remove workload from a component.
removeWorkload
in interface AmazonApplicationInsights
removeWorkloadRequest
- 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.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.
tagResource
in interface AmazonApplicationInsights
tagResourceRequest
- 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Remove one or more tags (keys and values) from a specified application.
untagResource
in interface AmazonApplicationInsights
untagResourceRequest
- ResourceNotFoundException
- The resource does not exist in the customer account.ValidationException
- The parameter is not valid.public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
Updates the application.
updateApplication
in interface AmazonApplicationInsights
updateApplicationRequest
- 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.public UpdateComponentResult updateComponent(UpdateComponentRequest request)
Updates the custom component name and/or the list of resources that make up the component.
updateComponent
in interface AmazonApplicationInsights
updateComponentRequest
- 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.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
.
updateComponentConfiguration
in interface AmazonApplicationInsights
updateComponentConfigurationRequest
- 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.ResourceInUseException
- The resource is already created or in use.public UpdateLogPatternResult updateLogPattern(UpdateLogPatternRequest request)
Adds a log pattern to a LogPatternSet
.
updateLogPattern
in interface AmazonApplicationInsights
updateLogPatternRequest
- 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.public UpdateProblemResult updateProblem(UpdateProblemRequest request)
Updates the visibility of the problem or specifies the problem as RESOLVED
.
updateProblem
in interface AmazonApplicationInsights
updateProblemRequest
- 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.public UpdateWorkloadResult updateWorkload(UpdateWorkloadRequest request)
Adds a workload to a component. Each component can have at most five workloads.
updateWorkload
in interface AmazonApplicationInsights
updateWorkloadRequest
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AmazonApplicationInsights
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonApplicationInsights
shutdown
in class AmazonWebServiceClient