@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonApplicationSignalsClient extends AmazonWebServiceClient implements AmazonApplicationSignals
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
BatchGetServiceLevelObjectiveBudgetReportResult |
batchGetServiceLevelObjectiveBudgetReport(BatchGetServiceLevelObjectiveBudgetReportRequest request)
Use this operation to retrieve one or more service level objective (SLO) budget reports.
|
static AmazonApplicationSignalsClientBuilder |
builder() |
CreateServiceLevelObjectiveResult |
createServiceLevelObjective(CreateServiceLevelObjectiveRequest request)
Creates a service level objective (SLO), which can help you ensure that your critical business operations are
meeting customer expectations.
|
DeleteServiceLevelObjectiveResult |
deleteServiceLevelObjective(DeleteServiceLevelObjectiveRequest request)
Deletes the specified service level objective.
|
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.
|
GetServiceResult |
getService(GetServiceRequest request)
Returns information about a service discovered by Application Signals.
|
GetServiceLevelObjectiveResult |
getServiceLevelObjective(GetServiceLevelObjectiveRequest request)
Returns information about one SLO created in the account.
|
ListServiceDependenciesResult |
listServiceDependencies(ListServiceDependenciesRequest request)
Returns a list of service dependencies of the service that you specify.
|
ListServiceDependentsResult |
listServiceDependents(ListServiceDependentsRequest request)
Returns the list of dependents that invoked the specified service during the provided time range.
|
ListServiceLevelObjectivesResult |
listServiceLevelObjectives(ListServiceLevelObjectivesRequest request)
Returns a list of SLOs created in this account.
|
ListServiceOperationsResult |
listServiceOperations(ListServiceOperationsRequest request)
Returns a list of the operations of this service that have been discovered by Application Signals.
|
ListServicesResult |
listServices(ListServicesRequest request)
Returns a list of services that have been discovered by Application Signals.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Displays the tags associated with a CloudWatch resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartDiscoveryResult |
startDiscovery(StartDiscoveryRequest request)
Enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the
AWSServiceRoleForCloudWatchApplicationSignals service-linked role.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level
objective.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from the specified resource.
|
UpdateServiceLevelObjectiveResult |
updateServiceLevelObjective(UpdateServiceLevelObjectiveRequest request)
Updates an existing service level objective (SLO).
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AmazonApplicationSignalsClientBuilder builder()
public BatchGetServiceLevelObjectiveBudgetReportResult batchGetServiceLevelObjectiveBudgetReport(BatchGetServiceLevelObjectiveBudgetReportRequest request)
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.
batchGetServiceLevelObjectiveBudgetReport in interface AmazonApplicationSignalsbatchGetServiceLevelObjectiveBudgetReportRequest - ValidationException - The resource is not valid.ThrottlingException - The request was throttled because of quota limits.public CreateServiceLevelObjectiveResult createServiceLevelObjective(CreateServiceLevelObjectiveRequest request)
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).
createServiceLevelObjective in interface AmazonApplicationSignalscreateServiceLevelObjectiveRequest - ValidationException - The resource is not valid.ThrottlingException - The request was throttled because of quota limits.AccessDeniedException - You don't have sufficient permissions to perform this action.ServiceQuotaExceededException - This request exceeds a service quota.ConflictException - This operation attempted to create a resource that already exists.public DeleteServiceLevelObjectiveResult deleteServiceLevelObjective(DeleteServiceLevelObjectiveRequest request)
Deletes the specified service level objective.
deleteServiceLevelObjective in interface AmazonApplicationSignalsdeleteServiceLevelObjectiveRequest - ValidationException - The resource is not valid.ResourceNotFoundException - Resource not found.ThrottlingException - The request was throttled because of quota limits.public GetServiceResult getService(GetServiceRequest request)
Returns information about a service discovered by Application Signals.
getService in interface AmazonApplicationSignalsgetServiceRequest - ValidationException - The resource is not valid.ThrottlingException - The request was throttled because of quota limits.public GetServiceLevelObjectiveResult getServiceLevelObjective(GetServiceLevelObjectiveRequest request)
Returns information about one SLO created in the account.
getServiceLevelObjective in interface AmazonApplicationSignalsgetServiceLevelObjectiveRequest - ValidationException - The resource is not valid.ResourceNotFoundException - Resource not found.ThrottlingException - The request was throttled because of quota limits.public ListServiceDependenciesResult listServiceDependencies(ListServiceDependenciesRequest request)
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.
listServiceDependencies in interface AmazonApplicationSignalslistServiceDependenciesRequest - ValidationException - The resource is not valid.ThrottlingException - The request was throttled because of quota limits.public ListServiceDependentsResult listServiceDependents(ListServiceDependentsRequest request)
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.
listServiceDependents in interface AmazonApplicationSignalslistServiceDependentsRequest - ValidationException - The resource is not valid.ThrottlingException - The request was throttled because of quota limits.public ListServiceLevelObjectivesResult listServiceLevelObjectives(ListServiceLevelObjectivesRequest request)
Returns a list of SLOs created in this account.
listServiceLevelObjectives in interface AmazonApplicationSignalslistServiceLevelObjectivesRequest - ValidationException - The resource is not valid.ThrottlingException - The request was throttled because of quota limits.public ListServiceOperationsResult listServiceOperations(ListServiceOperationsRequest request)
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.
listServiceOperations in interface AmazonApplicationSignalslistServiceOperationsRequest - ValidationException - The resource is not valid.ThrottlingException - The request was throttled because of quota limits.public ListServicesResult listServices(ListServicesRequest request)
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.
listServices in interface AmazonApplicationSignalslistServicesRequest - ValidationException - The resource is not valid.ThrottlingException - The request was throttled because of quota limits.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Displays the tags associated with a CloudWatch resource. Tags can be assigned to service level objectives.
listTagsForResource in interface AmazonApplicationSignalslistTagsForResourceRequest - ResourceNotFoundException - Resource not found.ThrottlingException - The request was throttled because of quota limits.public StartDiscoveryResult startDiscovery(StartDiscoveryRequest request)
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.
startDiscovery in interface AmazonApplicationSignalsstartDiscoveryRequest - ValidationException - The resource is not valid.ThrottlingException - The request was throttled because of quota limits.AccessDeniedException - You don't have sufficient permissions to perform this action.public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource in interface AmazonApplicationSignalstagResourceRequest - ResourceNotFoundException - Resource not found.ThrottlingException - The request was throttled because of quota limits.ServiceQuotaExceededException - This request exceeds a service quota.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes one or more tags from the specified resource.
untagResource in interface AmazonApplicationSignalsuntagResourceRequest - ResourceNotFoundException - Resource not found.ThrottlingException - The request was throttled because of quota limits.public UpdateServiceLevelObjectiveResult updateServiceLevelObjective(UpdateServiceLevelObjectiveRequest request)
Updates an existing service level objective (SLO). If you omit parameters, the previous values of those parameters are retained.
updateServiceLevelObjective in interface AmazonApplicationSignalsupdateServiceLevelObjectiveRequest - ValidationException - The resource is not valid.ResourceNotFoundException - Resource not found.ThrottlingException - The request was throttled because of quota limits.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 AmazonApplicationSignalsrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AmazonApplicationSignalsshutdown in class AmazonWebServiceClient