com.amazonaws.services.applicationsignals.AmazonApplicationSignals Maven / Gradle / Ivy
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.applicationsignals;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.applicationsignals.model.*;
/**
* Interface for accessing Amazon CloudWatch Application Signals.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.applicationsignals.AbstractAmazonApplicationSignals} instead.
*
*
*
* Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications. It enables
* real-time service health dashboards and helps you track long-term performance trends against your business goals. The
* application-centric view provides you with unified visibility across your applications, services, and dependencies,
* so you can proactively monitor and efficiently triage any issues that may arise, ensuring optimal customer
* experience.
*
*
* Application Signals provides the following benefits:
*
*
* -
*
* Automatically collect metrics and traces from your applications, and display key metrics such as call volume,
* availability, latency, faults, and errors.
*
*
* -
*
* Create and monitor service level objectives (SLOs).
*
*
* -
*
* See a map of your application topology that Application Signals automatically discovers, that gives you a visual
* representation of your applications, dependencies, and their connectivity.
*
*
*
*
* Application Signals works with CloudWatch RUM, CloudWatch Synthetics canaries, and Amazon Web Services Service
* Catalog AppRegistry, to display your client pages, Synthetics canaries, and application names within dashboards and
* maps.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonApplicationSignals {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "application-signals";
/**
*
* Use this operation to retrieve one or more service level objective (SLO) budget reports.
*
*
* An error budget is the amount of time in unhealthy periods that your service can accumulate during an
* interval before your overall SLO budget health is breached and the SLO is considered to be unmet. For example, an
* SLO with a threshold of 99.95% and a monthly interval translates to an error budget of 21.9 minutes of downtime
* in a 30-day month.
*
*
* Budget reports include a health indicator, the attainment value, and remaining budget.
*
*
* For more information about SLO error budgets, see SLO concepts.
*
*
* @param batchGetServiceLevelObjectiveBudgetReportRequest
* @return Result of the BatchGetServiceLevelObjectiveBudgetReport operation returned by the service.
* @throws ValidationException
* The resource is not valid.
* @throws ThrottlingException
* The request was throttled because of quota limits.
* @sample AmazonApplicationSignals.BatchGetServiceLevelObjectiveBudgetReport
* @see AWS API Documentation
*/
BatchGetServiceLevelObjectiveBudgetReportResult batchGetServiceLevelObjectiveBudgetReport(
BatchGetServiceLevelObjectiveBudgetReportRequest batchGetServiceLevelObjectiveBudgetReportRequest);
/**
*
* Creates a service level objective (SLO), which can help you ensure that your critical business operations are
* meeting customer expectations. Use SLOs to set and track specific target levels for the reliability and
* availability of your applications and services. SLOs use service level indicators (SLIs) to calculate whether the
* application is performing at the level that you want.
*
*
* Create an SLO to set a target for a service or operation’s availability or latency. CloudWatch measures this
* target frequently you can find whether it has been breached.
*
*
* When you create an SLO, you set an attainment goal for it. An attainment goal is the ratio of good
* periods that meet the threshold requirements to the total periods within the interval. For example, an attainment
* goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.
*
*
* After you have created an SLO, you can retrieve error budget reports for it. An error budget is the number
* of periods or amount of time that your service can accumulate during an interval before your overall SLO budget
* health is breached and the SLO is considered to be unmet. for example, an SLO with a threshold that 99.95% of
* requests must be completed under 2000ms every month translates to an error budget of 21.9 minutes of downtime per
* month.
*
*
* When you call this operation, Application Signals creates the
* AWSServiceRoleForCloudWatchApplicationSignals service-linked role, if it doesn't already exist in your
* account. This service- linked role has the following permissions:
*
*
* -
*
* xray:GetServiceGraph
*
*
* -
*
* logs:StartQuery
*
*
* -
*
* logs:GetQueryResults
*
*
* -
*
* cloudwatch:GetMetricData
*
*
* -
*
* cloudwatch:ListMetrics
*
*
* -
*
* tag:GetResources
*
*
* -
*
* autoscaling:DescribeAutoScalingGroups
*
*
*
*
* You can easily set SLO targets for your applications that are discovered by Application Signals, using critical
* metrics such as latency and availability. You can also set SLOs against any CloudWatch metric or math expression
* that produces a time series.
*
*
* For more information about SLOs, see
* Service level objectives (SLOs).
*
*
* @param createServiceLevelObjectiveRequest
* @return Result of the CreateServiceLevelObjective operation returned by the service.
* @throws ValidationException
* The resource is not valid.
* @throws ThrottlingException
* The request was throttled because of quota limits.
* @throws AccessDeniedException
* You don't have sufficient permissions to perform this action.
* @throws ServiceQuotaExceededException
* This request exceeds a service quota.
* @throws ConflictException
* This operation attempted to create a resource that already exists.
* @sample AmazonApplicationSignals.CreateServiceLevelObjective
* @see AWS API Documentation
*/
CreateServiceLevelObjectiveResult createServiceLevelObjective(CreateServiceLevelObjectiveRequest createServiceLevelObjectiveRequest);
/**
*
* Deletes the specified service level objective.
*
*
* @param deleteServiceLevelObjectiveRequest
* @return Result of the DeleteServiceLevelObjective operation returned by the service.
* @throws ValidationException
* The resource is not valid.
* @throws ResourceNotFoundException
* Resource not found.
* @throws ThrottlingException
* The request was throttled because of quota limits.
* @sample AmazonApplicationSignals.DeleteServiceLevelObjective
* @see AWS API Documentation
*/
DeleteServiceLevelObjectiveResult deleteServiceLevelObjective(DeleteServiceLevelObjectiveRequest deleteServiceLevelObjectiveRequest);
/**
*
* Returns information about a service discovered by Application Signals.
*
*
* @param getServiceRequest
* @return Result of the GetService operation returned by the service.
* @throws ValidationException
* The resource is not valid.
* @throws ThrottlingException
* The request was throttled because of quota limits.
* @sample AmazonApplicationSignals.GetService
* @see AWS
* API Documentation
*/
GetServiceResult getService(GetServiceRequest getServiceRequest);
/**
*
* Returns information about one SLO created in the account.
*
*
* @param getServiceLevelObjectiveRequest
* @return Result of the GetServiceLevelObjective operation returned by the service.
* @throws ValidationException
* The resource is not valid.
* @throws ResourceNotFoundException
* Resource not found.
* @throws ThrottlingException
* The request was throttled because of quota limits.
* @sample AmazonApplicationSignals.GetServiceLevelObjective
* @see AWS API Documentation
*/
GetServiceLevelObjectiveResult getServiceLevelObjective(GetServiceLevelObjectiveRequest getServiceLevelObjectiveRequest);
/**
*
* Returns a list of service dependencies of the service that you specify. A dependency is an infrastructure
* component that an operation of this service connects with. Dependencies can include Amazon Web Services services,
* Amazon Web Services resources, and third-party services.
*
*
* @param listServiceDependenciesRequest
* @return Result of the ListServiceDependencies operation returned by the service.
* @throws ValidationException
* The resource is not valid.
* @throws ThrottlingException
* The request was throttled because of quota limits.
* @sample AmazonApplicationSignals.ListServiceDependencies
* @see AWS API Documentation
*/
ListServiceDependenciesResult listServiceDependencies(ListServiceDependenciesRequest listServiceDependenciesRequest);
/**
*
* Returns the list of dependents that invoked the specified service during the provided time range. Dependents
* include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app
* monitors.
*
*
* @param listServiceDependentsRequest
* @return Result of the ListServiceDependents operation returned by the service.
* @throws ValidationException
* The resource is not valid.
* @throws ThrottlingException
* The request was throttled because of quota limits.
* @sample AmazonApplicationSignals.ListServiceDependents
* @see AWS API Documentation
*/
ListServiceDependentsResult listServiceDependents(ListServiceDependentsRequest listServiceDependentsRequest);
/**
*
* Returns a list of SLOs created in this account.
*
*
* @param listServiceLevelObjectivesRequest
* @return Result of the ListServiceLevelObjectives operation returned by the service.
* @throws ValidationException
* The resource is not valid.
* @throws ThrottlingException
* The request was throttled because of quota limits.
* @sample AmazonApplicationSignals.ListServiceLevelObjectives
* @see AWS API Documentation
*/
ListServiceLevelObjectivesResult listServiceLevelObjectives(ListServiceLevelObjectivesRequest listServiceLevelObjectivesRequest);
/**
*
* Returns a list of the operations of this service that have been discovered by Application Signals. Only
* the operations that were invoked during the specified time range are returned.
*
*
* @param listServiceOperationsRequest
* @return Result of the ListServiceOperations operation returned by the service.
* @throws ValidationException
* The resource is not valid.
* @throws ThrottlingException
* The request was throttled because of quota limits.
* @sample AmazonApplicationSignals.ListServiceOperations
* @see AWS API Documentation
*/
ListServiceOperationsResult listServiceOperations(ListServiceOperationsRequest listServiceOperationsRequest);
/**
*
* Returns a list of services that have been discovered by Application Signals. A service represents a minimum
* logical and transactional unit that completes a business function. Services are discovered through Application
* Signals instrumentation.
*
*
* @param listServicesRequest
* @return Result of the ListServices operation returned by the service.
* @throws ValidationException
* The resource is not valid.
* @throws ThrottlingException
* The request was throttled because of quota limits.
* @sample AmazonApplicationSignals.ListServices
* @see AWS API Documentation
*/
ListServicesResult listServices(ListServicesRequest listServicesRequest);
/**
*
* Displays the tags associated with a CloudWatch resource. Tags can be assigned to service level objectives.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* Resource not found.
* @throws ThrottlingException
* The request was throttled because of quota limits.
* @sample AmazonApplicationSignals.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the
* AWSServiceRoleForCloudWatchApplicationSignals service-linked role. This service- linked role has the
* following permissions:
*
*
* -
*
* xray:GetServiceGraph
*
*
* -
*
* logs:StartQuery
*
*
* -
*
* logs:GetQueryResults
*
*
* -
*
* cloudwatch:GetMetricData
*
*
* -
*
* cloudwatch:ListMetrics
*
*
* -
*
* tag:GetResources
*
*
* -
*
* autoscaling:DescribeAutoScalingGroups
*
*
*
*
* After completing this step, you still need to instrument your Java and Python applications to send data to
* Application Signals. For more information, see
* Enabling Application Signals.
*
*
* @param startDiscoveryRequest
* @return Result of the StartDiscovery operation returned by the service.
* @throws ValidationException
* The resource is not valid.
* @throws ThrottlingException
* The request was throttled because of quota limits.
* @throws AccessDeniedException
* You don't have sufficient permissions to perform this action.
* @sample AmazonApplicationSignals.StartDiscovery
* @see AWS API Documentation
*/
StartDiscoveryResult startDiscovery(StartDiscoveryRequest startDiscoveryRequest);
/**
*
* Assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level
* objective.
*
*
* Tags can help you organize and categorize your resources. You can also use them to scope user permissions by
* granting a user permission to access or change only resources with certain tag values.
*
*
* Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of
* characters.
*
*
* You can use the TagResource action with an alarm that already has tags. If you specify a new tag key
* for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that
* is already associated with the alarm, the new tag value that you specify replaces the previous value for that
* tag.
*
*
* You can associate as many as 50 tags with a CloudWatch resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* Resource not found.
* @throws ThrottlingException
* The request was throttled because of quota limits.
* @throws ServiceQuotaExceededException
* This request exceeds a service quota.
* @sample AmazonApplicationSignals.TagResource
* @see AWS API Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes one or more tags from the specified resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* Resource not found.
* @throws ThrottlingException
* The request was throttled because of quota limits.
* @sample AmazonApplicationSignals.UntagResource
* @see AWS API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates an existing service level objective (SLO). If you omit parameters, the previous values of those
* parameters are retained.
*
*
* @param updateServiceLevelObjectiveRequest
* @return Result of the UpdateServiceLevelObjective operation returned by the service.
* @throws ValidationException
* The resource is not valid.
* @throws ResourceNotFoundException
* Resource not found.
* @throws ThrottlingException
* The request was throttled because of quota limits.
* @sample AmazonApplicationSignals.UpdateServiceLevelObjective
* @see AWS API Documentation
*/
UpdateServiceLevelObjectiveResult updateServiceLevelObjective(UpdateServiceLevelObjectiveRequest updateServiceLevelObjectiveRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}