Class: Aws::ApplicationSignals::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ApplicationSignals::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb
Overview
An API client for ApplicationSignals. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ApplicationSignals::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_get_service_level_objective_budget_report(params = {}) ⇒ Types::BatchGetServiceLevelObjectiveBudgetReportOutput
Use this operation to retrieve one or more service level objective (SLO) budget reports.
-
#create_service_level_objective(params = {}) ⇒ Types::CreateServiceLevelObjectiveOutput
Creates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations.
-
#delete_service_level_objective(params = {}) ⇒ Struct
Deletes the specified service level objective.
-
#get_service(params = {}) ⇒ Types::GetServiceOutput
Returns information about a service discovered by Application Signals.
-
#get_service_level_objective(params = {}) ⇒ Types::GetServiceLevelObjectiveOutput
Returns information about one SLO created in the account.
-
#list_service_dependencies(params = {}) ⇒ Types::ListServiceDependenciesOutput
Returns a list of service dependencies of the service that you specify.
-
#list_service_dependents(params = {}) ⇒ Types::ListServiceDependentsOutput
Returns the list of dependents that invoked the specified service during the provided time range.
-
#list_service_level_objectives(params = {}) ⇒ Types::ListServiceLevelObjectivesOutput
Returns a list of SLOs created in this account.
-
#list_service_operations(params = {}) ⇒ Types::ListServiceOperationsOutput
Returns a list of the operations of this service that have been discovered by Application Signals.
-
#list_services(params = {}) ⇒ Types::ListServicesOutput
Returns a list of services that have been discovered by Application Signals.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Displays the tags associated with a CloudWatch resource.
-
#start_discovery(params = {}) ⇒ Struct
Enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role.
-
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level objective.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified resource.
-
#update_service_level_objective(params = {}) ⇒ Types::UpdateServiceLevelObjectiveOutput
Updates an existing service level objective (SLO).
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
422 423 424 |
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 422 def initialize(*args) super end |
Instance Method Details
#batch_get_service_level_objective_budget_report(params = {}) ⇒ Types::BatchGetServiceLevelObjectiveBudgetReportOutput
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.
516 517 518 519 |
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 516 def batch_get_service_level_objective_budget_report(params = {}, = {}) req = build_request(:batch_get_service_level_objective_budget_report, params) req.send_request() end |
#create_service_level_objective(params = {}) ⇒ Types::CreateServiceLevelObjectiveOutput
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).
712 713 714 715 |
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 712 def create_service_level_objective(params = {}, = {}) req = build_request(:create_service_level_objective, params) req.send_request() end |
#delete_service_level_objective(params = {}) ⇒ Struct
Deletes the specified service level objective.
734 735 736 737 |
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 734 def delete_service_level_objective(params = {}, = {}) req = build_request(:delete_service_level_objective, params) req.send_request() end |
#get_service(params = {}) ⇒ Types::GetServiceOutput
Returns information about a service discovered by Application Signals.
823 824 825 826 |
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 823 def get_service(params = {}, = {}) req = build_request(:get_service, params) req.send_request() end |
#get_service_level_objective(params = {}) ⇒ Types::GetServiceLevelObjectiveOutput
Returns information about one SLO created in the account.
889 890 891 892 |
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 889 def get_service_level_objective(params = {}, = {}) req = build_request(:get_service_level_objective, params) req.send_request() end |
#list_service_dependencies(params = {}) ⇒ Types::ListServiceDependenciesOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
989 990 991 992 |
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 989 def list_service_dependencies(params = {}, = {}) req = build_request(:list_service_dependencies, params) req.send_request() end |
#list_service_dependents(params = {}) ⇒ Types::ListServiceDependentsOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1088 1089 1090 1091 |
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1088 def list_service_dependents(params = {}, = {}) req = build_request(:list_service_dependents, params) req.send_request() end |
#list_service_level_objectives(params = {}) ⇒ Types::ListServiceLevelObjectivesOutput
Returns a list of SLOs created in this account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1162 1163 1164 1165 |
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1162 def list_service_level_objectives(params = {}, = {}) req = build_request(:list_service_level_objectives, params) req.send_request() end |
#list_service_operations(params = {}) ⇒ Types::ListServiceOperationsOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1257 1258 1259 1260 |
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1257 def list_service_operations(params = {}, = {}) req = build_request(:list_service_operations, params) req.send_request() end |
#list_services(params = {}) ⇒ Types::ListServicesOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1330 1331 1332 1333 |
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1330 def list_services(params = {}, = {}) req = build_request(:list_services, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Displays the tags associated with a CloudWatch resource. Tags can be assigned to service level objectives.
1372 1373 1374 1375 |
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1372 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_discovery(params = {}) ⇒ Struct
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.
1410 1411 1412 1413 |
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1410 def start_discovery(params = {}, = {}) req = build_request(:start_discovery, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
1468 1469 1470 1471 |
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1468 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified resource.
1505 1506 1507 1508 |
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1505 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_service_level_objective(params = {}) ⇒ Types::UpdateServiceLevelObjectiveOutput
Updates an existing service level objective (SLO). If you omit parameters, the previous values of those parameters are retained.
1633 1634 1635 1636 |
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1633 def update_service_level_objective(params = {}, = {}) req = build_request(:update_service_level_objective, params) req.send_request() end |