Class: Aws::ApplicationSignals::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::ApplicationSignals::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::ApplicationSignals::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



444
445
446
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 444

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 or requests in an unhealthy state 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.

Examples:

Request syntax with placeholder values


resp = client.batch_get_service_level_objective_budget_report({
  timestamp: Time.now, # required
  slo_ids: ["String"], # required
})

Response structure


resp.timestamp #=> Time
resp.reports #=> Array
resp.reports[0].arn #=> String
resp.reports[0].name #=> String
resp.reports[0].evaluation_type #=> String, one of "PeriodBased", "RequestBased"
resp.reports[0].budget_status #=> String, one of "OK", "WARNING", "BREACHED", "INSUFFICIENT_DATA"
resp.reports[0].attainment #=> Float
resp.reports[0].total_budget_seconds #=> Integer
resp.reports[0].budget_seconds_remaining #=> Integer
resp.reports[0].total_budget_requests #=> Integer
resp.reports[0].budget_requests_remaining #=> Integer
resp.reports[0].sli.sli_metric.key_attributes #=> Hash
resp.reports[0].sli.sli_metric.key_attributes["KeyAttributeName"] #=> String
resp.reports[0].sli.sli_metric.operation_name #=> String
resp.reports[0].sli.sli_metric.metric_type #=> String, one of "LATENCY", "AVAILABILITY"
resp.reports[0].sli.sli_metric.metric_data_queries #=> Array
resp.reports[0].sli.sli_metric.metric_data_queries[0].id #=> String
resp.reports[0].sli.sli_metric.metric_data_queries[0].metric_stat.metric.namespace #=> String
resp.reports[0].sli.sli_metric.metric_data_queries[0].metric_stat.metric.metric_name #=> String
resp.reports[0].sli.sli_metric.metric_data_queries[0].metric_stat.metric.dimensions #=> Array
resp.reports[0].sli.sli_metric.metric_data_queries[0].metric_stat.metric.dimensions[0].name #=> String
resp.reports[0].sli.sli_metric.metric_data_queries[0].metric_stat.metric.dimensions[0].value #=> String
resp.reports[0].sli.sli_metric.metric_data_queries[0].metric_stat.period #=> Integer
resp.reports[0].sli.sli_metric.metric_data_queries[0].metric_stat.stat #=> String
resp.reports[0].sli.sli_metric.metric_data_queries[0].metric_stat.unit #=> String, one of "Microseconds", "Milliseconds", "Seconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.reports[0].sli.sli_metric.metric_data_queries[0].expression #=> String
resp.reports[0].sli.sli_metric.metric_data_queries[0].label #=> String
resp.reports[0].sli.sli_metric.metric_data_queries[0].return_data #=> Boolean
resp.reports[0].sli.sli_metric.metric_data_queries[0].period #=> Integer
resp.reports[0].sli.sli_metric.metric_data_queries[0]. #=> String
resp.reports[0].sli.metric_threshold #=> Float
resp.reports[0].sli.comparison_operator #=> String, one of "GreaterThanOrEqualTo", "GreaterThan", "LessThan", "LessThanOrEqualTo"
resp.reports[0].request_based_sli.request_based_sli_metric.key_attributes #=> Hash
resp.reports[0].request_based_sli.request_based_sli_metric.key_attributes["KeyAttributeName"] #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.operation_name #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.metric_type #=> String, one of "LATENCY", "AVAILABILITY"
resp.reports[0].request_based_sli.request_based_sli_metric.total_request_count_metric #=> Array
resp.reports[0].request_based_sli.request_based_sli_metric.total_request_count_metric[0].id #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.namespace #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.metric_name #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.dimensions #=> Array
resp.reports[0].request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.dimensions[0].name #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.dimensions[0].value #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.period #=> Integer
resp.reports[0].request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.stat #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.unit #=> String, one of "Microseconds", "Milliseconds", "Seconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.reports[0].request_based_sli.request_based_sli_metric.total_request_count_metric[0].expression #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.total_request_count_metric[0].label #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.total_request_count_metric[0].return_data #=> Boolean
resp.reports[0].request_based_sli.request_based_sli_metric.total_request_count_metric[0].period #=> Integer
resp.reports[0].request_based_sli.request_based_sli_metric.total_request_count_metric[0]. #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric #=> Array
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].id #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.namespace #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.metric_name #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.dimensions #=> Array
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.dimensions[0].name #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.dimensions[0].value #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.period #=> Integer
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.stat #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.unit #=> String, one of "Microseconds", "Milliseconds", "Seconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].expression #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].label #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].return_data #=> Boolean
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].period #=> Integer
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0]. #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric #=> Array
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].id #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.namespace #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.metric_name #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.dimensions #=> Array
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.dimensions[0].name #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.dimensions[0].value #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.period #=> Integer
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.stat #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.unit #=> String, one of "Microseconds", "Milliseconds", "Seconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].expression #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].label #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].return_data #=> Boolean
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].period #=> Integer
resp.reports[0].request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0]. #=> String
resp.reports[0].request_based_sli.metric_threshold #=> Float
resp.reports[0].request_based_sli.comparison_operator #=> String, one of "GreaterThanOrEqualTo", "GreaterThan", "LessThan", "LessThanOrEqualTo"
resp.reports[0].goal.interval.rolling_interval.duration_unit #=> String, one of "MINUTE", "HOUR", "DAY", "MONTH"
resp.reports[0].goal.interval.rolling_interval.duration #=> Integer
resp.reports[0].goal.interval.calendar_interval.start_time #=> Time
resp.reports[0].goal.interval.calendar_interval.duration_unit #=> String, one of "MINUTE", "HOUR", "DAY", "MONTH"
resp.reports[0].goal.interval.calendar_interval.duration #=> Integer
resp.reports[0].goal.attainment_goal #=> Float
resp.reports[0].goal.warning_threshold #=> Float
resp.errors #=> Array
resp.errors[0].name #=> String
resp.errors[0].arn #=> String
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :timestamp (required, Time, DateTime, Date, Integer, String) —

    The date and time that you want the report to be for. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

  • :slo_ids (required, Array<String>) —

    An array containing the IDs of the service level objectives that you want to include in the report.

Returns:

See Also:



592
593
594
595
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 592

def batch_get_service_level_objective_budget_report(params = {}, options = {})
  req = build_request(:batch_get_service_level_objective_budget_report, params)
  req.send_request(options)
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.

The target performance quality that is defined for an SLO is the attainment goal.

You can 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.

When you create an SLO, you specify whether it is a period-based SLO or a request-based SLO. Each type of SLO has a different way of evaluating your application's performance against its attainment goal.

  • A period-based SLO uses defined periods of time within a specified total time interval. For each period of time, Application Signals determines whether the application met its goal. The attainment rate is calculated as the number of good periods/number of total periods.

    For example, for a period-based SLO, meeting an attainment goal of 99.9% means that within your interval, your application must meet its performance goal during at least 99.9% of the time periods.

  • A request-based SLO doesn't use pre-defined periods of time. Instead, the SLO measures number of good requests/number of total requests during the interval. At any time, you can find the ratio of good requests to total requests for the interval up to the time stamp that you specify, and measure that ratio against the goal set in your SLO.

After you have created an SLO, you can retrieve error budget reports for it. An error budget is the amount of time or amount of requests that your application can be non-compliant with the SLO's goal, and still have your application meet the goal.

  • For a period-based SLO, the error budget starts at a number defined by the highest number of periods that can fail to meet the threshold, while still meeting the overall goal. The remaining error budget decreases with every failed period that is recorded. The error budget within one interval can never increase.

    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.

  • For a request-based SLO, the remaining error budget is dynamic and can increase or decrease, depending on the ratio of good requests to total requests.

For more information about SLOs, see Service level objectives (SLOs).

When you perform a CreateServiceLevelObjective 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

Examples:

Request syntax with placeholder values


resp = client.create_service_level_objective({
  name: "ServiceLevelObjectiveName", # required
  description: "ServiceLevelObjectiveDescription",
  sli_config: {
    sli_metric_config: { # required
      key_attributes: {
        "KeyAttributeName" => "KeyAttributeValue",
      },
      operation_name: "OperationName",
      metric_type: "LATENCY", # accepts LATENCY, AVAILABILITY
      statistic: "ServiceLevelIndicatorStatistic",
      period_seconds: 1,
      metric_data_queries: [
        {
          id: "MetricId", # required
          metric_stat: {
            metric: { # required
              namespace: "Namespace",
              metric_name: "MetricName",
              dimensions: [
                {
                  name: "DimensionName", # required
                  value: "DimensionValue", # required
                },
              ],
            },
            period: 1, # required
            stat: "Stat", # required
            unit: "Microseconds", # accepts Microseconds, Milliseconds, Seconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
          },
          expression: "MetricExpression",
          label: "MetricLabel",
          return_data: false,
          period: 1,
          account_id: "AccountId",
        },
      ],
    },
    metric_threshold: 1.0, # required
    comparison_operator: "GreaterThanOrEqualTo", # required, accepts GreaterThanOrEqualTo, GreaterThan, LessThan, LessThanOrEqualTo
  },
  request_based_sli_config: {
    request_based_sli_metric_config: { # required
      key_attributes: {
        "KeyAttributeName" => "KeyAttributeValue",
      },
      operation_name: "OperationName",
      metric_type: "LATENCY", # accepts LATENCY, AVAILABILITY
      total_request_count_metric: [
        {
          id: "MetricId", # required
          metric_stat: {
            metric: { # required
              namespace: "Namespace",
              metric_name: "MetricName",
              dimensions: [
                {
                  name: "DimensionName", # required
                  value: "DimensionValue", # required
                },
              ],
            },
            period: 1, # required
            stat: "Stat", # required
            unit: "Microseconds", # accepts Microseconds, Milliseconds, Seconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
          },
          expression: "MetricExpression",
          label: "MetricLabel",
          return_data: false,
          period: 1,
          account_id: "AccountId",
        },
      ],
      monitored_request_count_metric: {
        good_count_metric: [
          {
            id: "MetricId", # required
            metric_stat: {
              metric: { # required
                namespace: "Namespace",
                metric_name: "MetricName",
                dimensions: [
                  {
                    name: "DimensionName", # required
                    value: "DimensionValue", # required
                  },
                ],
              },
              period: 1, # required
              stat: "Stat", # required
              unit: "Microseconds", # accepts Microseconds, Milliseconds, Seconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
            },
            expression: "MetricExpression",
            label: "MetricLabel",
            return_data: false,
            period: 1,
            account_id: "AccountId",
          },
        ],
        bad_count_metric: [
          {
            id: "MetricId", # required
            metric_stat: {
              metric: { # required
                namespace: "Namespace",
                metric_name: "MetricName",
                dimensions: [
                  {
                    name: "DimensionName", # required
                    value: "DimensionValue", # required
                  },
                ],
              },
              period: 1, # required
              stat: "Stat", # required
              unit: "Microseconds", # accepts Microseconds, Milliseconds, Seconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
            },
            expression: "MetricExpression",
            label: "MetricLabel",
            return_data: false,
            period: 1,
            account_id: "AccountId",
          },
        ],
      },
    },
    metric_threshold: 1.0,
    comparison_operator: "GreaterThanOrEqualTo", # accepts GreaterThanOrEqualTo, GreaterThan, LessThan, LessThanOrEqualTo
  },
  goal: {
    interval: {
      rolling_interval: {
        duration_unit: "MINUTE", # required, accepts MINUTE, HOUR, DAY, MONTH
        duration: 1, # required
      },
      calendar_interval: {
        start_time: Time.now, # required
        duration_unit: "MINUTE", # required, accepts MINUTE, HOUR, DAY, MONTH
        duration: 1, # required
      },
    },
    attainment_goal: 1.0,
    warning_threshold: 1.0,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  burn_rate_configurations: [
    {
      look_back_window_minutes: 1, # required
    },
  ],
})

Response structure


resp.slo.arn #=> String
resp.slo.name #=> String
resp.slo.description #=> String
resp.slo.created_time #=> Time
resp.slo.last_updated_time #=> Time
resp.slo.sli.sli_metric.key_attributes #=> Hash
resp.slo.sli.sli_metric.key_attributes["KeyAttributeName"] #=> String
resp.slo.sli.sli_metric.operation_name #=> String
resp.slo.sli.sli_metric.metric_type #=> String, one of "LATENCY", "AVAILABILITY"
resp.slo.sli.sli_metric.metric_data_queries #=> Array
resp.slo.sli.sli_metric.metric_data_queries[0].id #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.metric.namespace #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.metric.metric_name #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.metric.dimensions #=> Array
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.metric.dimensions[0].name #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.metric.dimensions[0].value #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.period #=> Integer
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.stat #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.unit #=> String, one of "Microseconds", "Milliseconds", "Seconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.slo.sli.sli_metric.metric_data_queries[0].expression #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].label #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].return_data #=> Boolean
resp.slo.sli.sli_metric.metric_data_queries[0].period #=> Integer
resp.slo.sli.sli_metric.metric_data_queries[0]. #=> String
resp.slo.sli.metric_threshold #=> Float
resp.slo.sli.comparison_operator #=> String, one of "GreaterThanOrEqualTo", "GreaterThan", "LessThan", "LessThanOrEqualTo"
resp.slo.request_based_sli.request_based_sli_metric.key_attributes #=> Hash
resp.slo.request_based_sli.request_based_sli_metric.key_attributes["KeyAttributeName"] #=> String
resp.slo.request_based_sli.request_based_sli_metric.operation_name #=> String
resp.slo.request_based_sli.request_based_sli_metric.metric_type #=> String, one of "LATENCY", "AVAILABILITY"
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric #=> Array
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].id #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.namespace #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.metric_name #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.dimensions #=> Array
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.dimensions[0].name #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.dimensions[0].value #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.stat #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.unit #=> String, one of "Microseconds", "Milliseconds", "Seconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].expression #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].label #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].return_data #=> Boolean
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0]. #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric #=> Array
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].id #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.namespace #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.metric_name #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.dimensions #=> Array
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.dimensions[0].name #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.dimensions[0].value #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.stat #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.unit #=> String, one of "Microseconds", "Milliseconds", "Seconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].expression #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].label #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].return_data #=> Boolean
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0]. #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric #=> Array
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].id #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.namespace #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.metric_name #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.dimensions #=> Array
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.dimensions[0].name #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.dimensions[0].value #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.stat #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.unit #=> String, one of "Microseconds", "Milliseconds", "Seconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].expression #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].label #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].return_data #=> Boolean
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0]. #=> String
resp.slo.request_based_sli.metric_threshold #=> Float
resp.slo.request_based_sli.comparison_operator #=> String, one of "GreaterThanOrEqualTo", "GreaterThan", "LessThan", "LessThanOrEqualTo"
resp.slo.evaluation_type #=> String, one of "PeriodBased", "RequestBased"
resp.slo.goal.interval.rolling_interval.duration_unit #=> String, one of "MINUTE", "HOUR", "DAY", "MONTH"
resp.slo.goal.interval.rolling_interval.duration #=> Integer
resp.slo.goal.interval.calendar_interval.start_time #=> Time
resp.slo.goal.interval.calendar_interval.duration_unit #=> String, one of "MINUTE", "HOUR", "DAY", "MONTH"
resp.slo.goal.interval.calendar_interval.duration #=> Integer
resp.slo.goal.attainment_goal #=> Float
resp.slo.goal.warning_threshold #=> Float
resp.slo.burn_rate_configurations #=> Array
resp.slo.burn_rate_configurations[0].look_back_window_minutes #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    A name for this SLO.

  • :description (String) —

    An optional description for this SLO.

  • :sli_config (Types::ServiceLevelIndicatorConfig) —

    If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.

    You can't specify both RequestBasedSliConfig and SliConfig in the same operation.

  • :request_based_sli_config (Types::RequestBasedServiceLevelIndicatorConfig) —

    If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.

    You can't specify both RequestBasedSliConfig and SliConfig in the same operation.

  • :goal (Types::Goal) —

    This structure contains the attributes that determine the goal of the SLO.

  • :tags (Array<Types::Tag>) —

    A list of key-value pairs to associate with the SLO. You can associate as many as 50 tags with an SLO. To be able to associate tags with the SLO when you create the SLO, you must have the cloudwatch:TagResource permission.

    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.

  • :burn_rate_configurations (Array<Types::BurnRateConfiguration>) —

    Use this array to create burn rates for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.

Returns:

See Also:



980
981
982
983
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 980

def create_service_level_objective(params = {}, options = {})
  req = build_request(:create_service_level_objective, params)
  req.send_request(options)
end

#delete_service_level_objective(params = {}) ⇒ Struct

Deletes the specified service level objective.

Examples:

Request syntax with placeholder values


resp = client.delete_service_level_objective({
  id: "ServiceLevelObjectiveId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ARN or name of the service level objective to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1002
1003
1004
1005
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1002

def delete_service_level_objective(params = {}, options = {})
  req = build_request(:delete_service_level_objective, params)
  req.send_request(options)
end

#get_service(params = {}) ⇒ Types::GetServiceOutput

Returns information about a service discovered by Application Signals.

Examples:

Request syntax with placeholder values


resp = client.get_service({
  start_time: Time.now, # required
  end_time: Time.now, # required
  key_attributes: { # required
    "KeyAttributeName" => "KeyAttributeValue",
  },
})

Response structure


resp.service.key_attributes #=> Hash
resp.service.key_attributes["KeyAttributeName"] #=> String
resp.service.attribute_maps #=> Array
resp.service.attribute_maps[0] #=> Hash
resp.service.attribute_maps[0]["String"] #=> String
resp.service.metric_references #=> Array
resp.service.metric_references[0].namespace #=> String
resp.service.metric_references[0].metric_type #=> String
resp.service.metric_references[0].dimensions #=> Array
resp.service.metric_references[0].dimensions[0].name #=> String
resp.service.metric_references[0].dimensions[0].value #=> String
resp.service.metric_references[0].metric_name #=> String
resp.service.log_group_references #=> Array
resp.service.log_group_references[0] #=> Hash
resp.service.log_group_references[0]["KeyAttributeName"] #=> String
resp.start_time #=> Time
resp.end_time #=> Time
resp.log_group_references #=> Array
resp.log_group_references[0] #=> Hash
resp.log_group_references[0]["KeyAttributeName"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :start_time (required, Time, DateTime, Date, Integer, String) —

    The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

  • :end_time (required, Time, DateTime, Date, Integer, String) —

    The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

  • :key_attributes (required, Hash<String,String>) —

    Use this field to specify which service you want to retrieve information for. You must specify at least the Type, Name, and Environment attributes.

    This is a string-to-string map. It can include the following fields.

    • Type designates the type of object this is.

    • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

    • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

    • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

    • Environment specifies the location where this object is hosted, or what it belongs to.

Returns:

See Also:



1091
1092
1093
1094
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1091

def get_service(params = {}, options = {})
  req = build_request(:get_service, params)
  req.send_request(options)
end

#get_service_level_objective(params = {}) ⇒ Types::GetServiceLevelObjectiveOutput

Returns information about one SLO created in the account.

Examples:

Request syntax with placeholder values


resp = client.get_service_level_objective({
  id: "ServiceLevelObjectiveId", # required
})

Response structure


resp.slo.arn #=> String
resp.slo.name #=> String
resp.slo.description #=> String
resp.slo.created_time #=> Time
resp.slo.last_updated_time #=> Time
resp.slo.sli.sli_metric.key_attributes #=> Hash
resp.slo.sli.sli_metric.key_attributes["KeyAttributeName"] #=> String
resp.slo.sli.sli_metric.operation_name #=> String
resp.slo.sli.sli_metric.metric_type #=> String, one of "LATENCY", "AVAILABILITY"
resp.slo.sli.sli_metric.metric_data_queries #=> Array
resp.slo.sli.sli_metric.metric_data_queries[0].id #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.metric.namespace #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.metric.metric_name #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.metric.dimensions #=> Array
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.metric.dimensions[0].name #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.metric.dimensions[0].value #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.period #=> Integer
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.stat #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.unit #=> String, one of "Microseconds", "Milliseconds", "Seconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.slo.sli.sli_metric.metric_data_queries[0].expression #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].label #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].return_data #=> Boolean
resp.slo.sli.sli_metric.metric_data_queries[0].period #=> Integer
resp.slo.sli.sli_metric.metric_data_queries[0]. #=> String
resp.slo.sli.metric_threshold #=> Float
resp.slo.sli.comparison_operator #=> String, one of "GreaterThanOrEqualTo", "GreaterThan", "LessThan", "LessThanOrEqualTo"
resp.slo.request_based_sli.request_based_sli_metric.key_attributes #=> Hash
resp.slo.request_based_sli.request_based_sli_metric.key_attributes["KeyAttributeName"] #=> String
resp.slo.request_based_sli.request_based_sli_metric.operation_name #=> String
resp.slo.request_based_sli.request_based_sli_metric.metric_type #=> String, one of "LATENCY", "AVAILABILITY"
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric #=> Array
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].id #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.namespace #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.metric_name #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.dimensions #=> Array
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.dimensions[0].name #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.dimensions[0].value #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.stat #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.unit #=> String, one of "Microseconds", "Milliseconds", "Seconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].expression #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].label #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].return_data #=> Boolean
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0]. #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric #=> Array
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].id #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.namespace #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.metric_name #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.dimensions #=> Array
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.dimensions[0].name #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.dimensions[0].value #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.stat #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.unit #=> String, one of "Microseconds", "Milliseconds", "Seconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].expression #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].label #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].return_data #=> Boolean
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0]. #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric #=> Array
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].id #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.namespace #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.metric_name #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.dimensions #=> Array
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.dimensions[0].name #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.dimensions[0].value #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.stat #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.unit #=> String, one of "Microseconds", "Milliseconds", "Seconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].expression #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].label #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].return_data #=> Boolean
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0]. #=> String
resp.slo.request_based_sli.metric_threshold #=> Float
resp.slo.request_based_sli.comparison_operator #=> String, one of "GreaterThanOrEqualTo", "GreaterThan", "LessThan", "LessThanOrEqualTo"
resp.slo.evaluation_type #=> String, one of "PeriodBased", "RequestBased"
resp.slo.goal.interval.rolling_interval.duration_unit #=> String, one of "MINUTE", "HOUR", "DAY", "MONTH"
resp.slo.goal.interval.rolling_interval.duration #=> Integer
resp.slo.goal.interval.calendar_interval.start_time #=> Time
resp.slo.goal.interval.calendar_interval.duration_unit #=> String, one of "MINUTE", "HOUR", "DAY", "MONTH"
resp.slo.goal.interval.calendar_interval.duration #=> Integer
resp.slo.goal.attainment_goal #=> Float
resp.slo.goal.warning_threshold #=> Float
resp.slo.burn_rate_configurations #=> Array
resp.slo.burn_rate_configurations[0].look_back_window_minutes #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ARN or name of the SLO that you want to retrieve information about. You can find the ARNs of SLOs by using the ListServiceLevelObjectives operation.

Returns:

See Also:



1211
1212
1213
1214
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1211

def get_service_level_objective(params = {}, options = {})
  req = build_request(:get_service_level_objective, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_service_dependencies({
  start_time: Time.now, # required
  end_time: Time.now, # required
  key_attributes: { # required
    "KeyAttributeName" => "KeyAttributeValue",
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.start_time #=> Time
resp.end_time #=> Time
resp.service_dependencies #=> Array
resp.service_dependencies[0].operation_name #=> String
resp.service_dependencies[0].dependency_key_attributes #=> Hash
resp.service_dependencies[0].dependency_key_attributes["KeyAttributeName"] #=> String
resp.service_dependencies[0].dependency_operation_name #=> String
resp.service_dependencies[0].metric_references #=> Array
resp.service_dependencies[0].metric_references[0].namespace #=> String
resp.service_dependencies[0].metric_references[0].metric_type #=> String
resp.service_dependencies[0].metric_references[0].dimensions #=> Array
resp.service_dependencies[0].metric_references[0].dimensions[0].name #=> String
resp.service_dependencies[0].metric_references[0].dimensions[0].value #=> String
resp.service_dependencies[0].metric_references[0].metric_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :start_time (required, Time, DateTime, Date, Integer, String) —

    The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

  • :end_time (required, Time, DateTime, Date, Integer, String) —

    The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested end time will be rounded to the nearest hour.

  • :key_attributes (required, Hash<String,String>) —

    Use this field to specify which service you want to retrieve information for. You must specify at least the Type, Name, and Environment attributes.

    This is a string-to-string map. It can include the following fields.

    • Type designates the type of object this is.

    • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

    • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

    • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

    • Environment specifies the location where this object is hosted, or what it belongs to.

  • :max_results (Integer) —

    The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

  • :next_token (String) —

    Include this value, if it was returned by the previous operation, to get the next set of service dependencies.

Returns:

See Also:



1311
1312
1313
1314
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1311

def list_service_dependencies(params = {}, options = {})
  req = build_request(:list_service_dependencies, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_service_dependents({
  start_time: Time.now, # required
  end_time: Time.now, # required
  key_attributes: { # required
    "KeyAttributeName" => "KeyAttributeValue",
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.start_time #=> Time
resp.end_time #=> Time
resp.service_dependents #=> Array
resp.service_dependents[0].operation_name #=> String
resp.service_dependents[0].dependent_key_attributes #=> Hash
resp.service_dependents[0].dependent_key_attributes["KeyAttributeName"] #=> String
resp.service_dependents[0].dependent_operation_name #=> String
resp.service_dependents[0].metric_references #=> Array
resp.service_dependents[0].metric_references[0].namespace #=> String
resp.service_dependents[0].metric_references[0].metric_type #=> String
resp.service_dependents[0].metric_references[0].dimensions #=> Array
resp.service_dependents[0].metric_references[0].dimensions[0].name #=> String
resp.service_dependents[0].metric_references[0].dimensions[0].value #=> String
resp.service_dependents[0].metric_references[0].metric_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :start_time (required, Time, DateTime, Date, Integer, String) —

    The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

  • :end_time (required, Time, DateTime, Date, Integer, String) —

    The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

  • :key_attributes (required, Hash<String,String>) —

    Use this field to specify which service you want to retrieve information for. You must specify at least the Type, Name, and Environment attributes.

    This is a string-to-string map. It can include the following fields.

    • Type designates the type of object this is.

    • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

    • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

    • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

    • Environment specifies the location where this object is hosted, or what it belongs to.

  • :max_results (Integer) —

    The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

  • :next_token (String) —

    Include this value, if it was returned by the previous operation, to get the next set of service dependents.

Returns:

See Also:



1410
1411
1412
1413
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1410

def list_service_dependents(params = {}, options = {})
  req = build_request(:list_service_dependents, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_service_level_objectives({
  key_attributes: {
    "KeyAttributeName" => "KeyAttributeValue",
  },
  operation_name: "OperationName",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.slo_summaries #=> Array
resp.slo_summaries[0].arn #=> String
resp.slo_summaries[0].name #=> String
resp.slo_summaries[0].key_attributes #=> Hash
resp.slo_summaries[0].key_attributes["KeyAttributeName"] #=> String
resp.slo_summaries[0].operation_name #=> String
resp.slo_summaries[0].created_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_attributes (Hash<String,String>) —

    You can use this optional field to specify which services you want to retrieve SLO information for.

    This is a string-to-string map. It can include the following fields.

    • Type designates the type of object this is.

    • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

    • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

    • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

    • Environment specifies the location where this object is hosted, or what it belongs to.

  • :operation_name (String) —

    The name of the operation that this SLO is associated with.

  • :max_results (Integer) —

    The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

  • :next_token (String) —

    Include this value, if it was returned by the previous operation, to get the next set of service level objectives.

Returns:

See Also:



1484
1485
1486
1487
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1484

def list_service_level_objectives(params = {}, options = {})
  req = build_request(:list_service_level_objectives, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_service_operations({
  start_time: Time.now, # required
  end_time: Time.now, # required
  key_attributes: { # required
    "KeyAttributeName" => "KeyAttributeValue",
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.start_time #=> Time
resp.end_time #=> Time
resp.service_operations #=> Array
resp.service_operations[0].name #=> String
resp.service_operations[0].metric_references #=> Array
resp.service_operations[0].metric_references[0].namespace #=> String
resp.service_operations[0].metric_references[0].metric_type #=> String
resp.service_operations[0].metric_references[0].dimensions #=> Array
resp.service_operations[0].metric_references[0].dimensions[0].name #=> String
resp.service_operations[0].metric_references[0].dimensions[0].value #=> String
resp.service_operations[0].metric_references[0].metric_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :start_time (required, Time, DateTime, Date, Integer, String) —

    The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

  • :end_time (required, Time, DateTime, Date, Integer, String) —

    The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested end time will be rounded to the nearest hour.

  • :key_attributes (required, Hash<String,String>) —

    Use this field to specify which service you want to retrieve information for. You must specify at least the Type, Name, and Environment attributes.

    This is a string-to-string map. It can include the following fields.

    • Type designates the type of object this is.

    • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

    • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

    • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

    • Environment specifies the location where this object is hosted, or what it belongs to.

  • :max_results (Integer) —

    The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

  • :next_token (String) —

    Include this value, if it was returned by the previous operation, to get the next set of service operations.

Returns:

See Also:



1579
1580
1581
1582
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1579

def list_service_operations(params = {}, options = {})
  req = build_request(:list_service_operations, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_services({
  start_time: Time.now, # required
  end_time: Time.now, # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.start_time #=> Time
resp.end_time #=> Time
resp.service_summaries #=> Array
resp.service_summaries[0].key_attributes #=> Hash
resp.service_summaries[0].key_attributes["KeyAttributeName"] #=> String
resp.service_summaries[0].attribute_maps #=> Array
resp.service_summaries[0].attribute_maps[0] #=> Hash
resp.service_summaries[0].attribute_maps[0]["String"] #=> String
resp.service_summaries[0].metric_references #=> Array
resp.service_summaries[0].metric_references[0].namespace #=> String
resp.service_summaries[0].metric_references[0].metric_type #=> String
resp.service_summaries[0].metric_references[0].dimensions #=> Array
resp.service_summaries[0].metric_references[0].dimensions[0].name #=> String
resp.service_summaries[0].metric_references[0].dimensions[0].value #=> String
resp.service_summaries[0].metric_references[0].metric_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :start_time (required, Time, DateTime, Date, Integer, String) —

    The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

  • :end_time (required, Time, DateTime, Date, Integer, String) —

    The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

  • :max_results (Integer) —

    The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

  • :next_token (String) —

    Include this value, if it was returned by the previous operation, to get the next set of services.

Returns:

See Also:



1652
1653
1654
1655
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1652

def list_services(params = {}, options = {})
  req = build_request(:list_services, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Displays the tags associated with a CloudWatch resource. Tags can be assigned to service level objectives.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the CloudWatch resource that you want to view tags for.

    The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name

    For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

Returns:

See Also:



1694
1695
1696
1697
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1694

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
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.

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1732
1733
1734
1735
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1732

def start_discovery(params = {}, options = {})
  req = build_request(:start_discovery, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the CloudWatch resource that you want to set tags for.

    The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name

    For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

  • :tags (required, Array<Types::Tag>) —

    The list of key-value pairs to associate with the alarm.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1790
1791
1792
1793
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1790

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the CloudWatch resource that you want to delete tags from.

    The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name

    For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

  • :tag_keys (required, Array<String>) —

    The list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1827
1828
1829
1830
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1827

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
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.

You cannot change from a period-based SLO to a request-based SLO, or change from a request-based SLO to a period-based SLO.

Examples:

Request syntax with placeholder values


resp = client.update_service_level_objective({
  id: "ServiceLevelObjectiveId", # required
  description: "ServiceLevelObjectiveDescription",
  sli_config: {
    sli_metric_config: { # required
      key_attributes: {
        "KeyAttributeName" => "KeyAttributeValue",
      },
      operation_name: "OperationName",
      metric_type: "LATENCY", # accepts LATENCY, AVAILABILITY
      statistic: "ServiceLevelIndicatorStatistic",
      period_seconds: 1,
      metric_data_queries: [
        {
          id: "MetricId", # required
          metric_stat: {
            metric: { # required
              namespace: "Namespace",
              metric_name: "MetricName",
              dimensions: [
                {
                  name: "DimensionName", # required
                  value: "DimensionValue", # required
                },
              ],
            },
            period: 1, # required
            stat: "Stat", # required
            unit: "Microseconds", # accepts Microseconds, Milliseconds, Seconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
          },
          expression: "MetricExpression",
          label: "MetricLabel",
          return_data: false,
          period: 1,
          account_id: "AccountId",
        },
      ],
    },
    metric_threshold: 1.0, # required
    comparison_operator: "GreaterThanOrEqualTo", # required, accepts GreaterThanOrEqualTo, GreaterThan, LessThan, LessThanOrEqualTo
  },
  request_based_sli_config: {
    request_based_sli_metric_config: { # required
      key_attributes: {
        "KeyAttributeName" => "KeyAttributeValue",
      },
      operation_name: "OperationName",
      metric_type: "LATENCY", # accepts LATENCY, AVAILABILITY
      total_request_count_metric: [
        {
          id: "MetricId", # required
          metric_stat: {
            metric: { # required
              namespace: "Namespace",
              metric_name: "MetricName",
              dimensions: [
                {
                  name: "DimensionName", # required
                  value: "DimensionValue", # required
                },
              ],
            },
            period: 1, # required
            stat: "Stat", # required
            unit: "Microseconds", # accepts Microseconds, Milliseconds, Seconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
          },
          expression: "MetricExpression",
          label: "MetricLabel",
          return_data: false,
          period: 1,
          account_id: "AccountId",
        },
      ],
      monitored_request_count_metric: {
        good_count_metric: [
          {
            id: "MetricId", # required
            metric_stat: {
              metric: { # required
                namespace: "Namespace",
                metric_name: "MetricName",
                dimensions: [
                  {
                    name: "DimensionName", # required
                    value: "DimensionValue", # required
                  },
                ],
              },
              period: 1, # required
              stat: "Stat", # required
              unit: "Microseconds", # accepts Microseconds, Milliseconds, Seconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
            },
            expression: "MetricExpression",
            label: "MetricLabel",
            return_data: false,
            period: 1,
            account_id: "AccountId",
          },
        ],
        bad_count_metric: [
          {
            id: "MetricId", # required
            metric_stat: {
              metric: { # required
                namespace: "Namespace",
                metric_name: "MetricName",
                dimensions: [
                  {
                    name: "DimensionName", # required
                    value: "DimensionValue", # required
                  },
                ],
              },
              period: 1, # required
              stat: "Stat", # required
              unit: "Microseconds", # accepts Microseconds, Milliseconds, Seconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
            },
            expression: "MetricExpression",
            label: "MetricLabel",
            return_data: false,
            period: 1,
            account_id: "AccountId",
          },
        ],
      },
    },
    metric_threshold: 1.0,
    comparison_operator: "GreaterThanOrEqualTo", # accepts GreaterThanOrEqualTo, GreaterThan, LessThan, LessThanOrEqualTo
  },
  goal: {
    interval: {
      rolling_interval: {
        duration_unit: "MINUTE", # required, accepts MINUTE, HOUR, DAY, MONTH
        duration: 1, # required
      },
      calendar_interval: {
        start_time: Time.now, # required
        duration_unit: "MINUTE", # required, accepts MINUTE, HOUR, DAY, MONTH
        duration: 1, # required
      },
    },
    attainment_goal: 1.0,
    warning_threshold: 1.0,
  },
  burn_rate_configurations: [
    {
      look_back_window_minutes: 1, # required
    },
  ],
})

Response structure


resp.slo.arn #=> String
resp.slo.name #=> String
resp.slo.description #=> String
resp.slo.created_time #=> Time
resp.slo.last_updated_time #=> Time
resp.slo.sli.sli_metric.key_attributes #=> Hash
resp.slo.sli.sli_metric.key_attributes["KeyAttributeName"] #=> String
resp.slo.sli.sli_metric.operation_name #=> String
resp.slo.sli.sli_metric.metric_type #=> String, one of "LATENCY", "AVAILABILITY"
resp.slo.sli.sli_metric.metric_data_queries #=> Array
resp.slo.sli.sli_metric.metric_data_queries[0].id #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.metric.namespace #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.metric.metric_name #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.metric.dimensions #=> Array
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.metric.dimensions[0].name #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.metric.dimensions[0].value #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.period #=> Integer
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.stat #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].metric_stat.unit #=> String, one of "Microseconds", "Milliseconds", "Seconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.slo.sli.sli_metric.metric_data_queries[0].expression #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].label #=> String
resp.slo.sli.sli_metric.metric_data_queries[0].return_data #=> Boolean
resp.slo.sli.sli_metric.metric_data_queries[0].period #=> Integer
resp.slo.sli.sli_metric.metric_data_queries[0]. #=> String
resp.slo.sli.metric_threshold #=> Float
resp.slo.sli.comparison_operator #=> String, one of "GreaterThanOrEqualTo", "GreaterThan", "LessThan", "LessThanOrEqualTo"
resp.slo.request_based_sli.request_based_sli_metric.key_attributes #=> Hash
resp.slo.request_based_sli.request_based_sli_metric.key_attributes["KeyAttributeName"] #=> String
resp.slo.request_based_sli.request_based_sli_metric.operation_name #=> String
resp.slo.request_based_sli.request_based_sli_metric.metric_type #=> String, one of "LATENCY", "AVAILABILITY"
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric #=> Array
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].id #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.namespace #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.metric_name #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.dimensions #=> Array
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.dimensions[0].name #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.metric.dimensions[0].value #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.stat #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].metric_stat.unit #=> String, one of "Microseconds", "Milliseconds", "Seconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].expression #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].label #=> String
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].return_data #=> Boolean
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0].period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.total_request_count_metric[0]. #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric #=> Array
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].id #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.namespace #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.metric_name #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.dimensions #=> Array
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.dimensions[0].name #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.metric.dimensions[0].value #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.stat #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].metric_stat.unit #=> String, one of "Microseconds", "Milliseconds", "Seconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].expression #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].label #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].return_data #=> Boolean
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0].period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.good_count_metric[0]. #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric #=> Array
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].id #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.namespace #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.metric_name #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.dimensions #=> Array
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.dimensions[0].name #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.metric.dimensions[0].value #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.stat #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].metric_stat.unit #=> String, one of "Microseconds", "Milliseconds", "Seconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].expression #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].label #=> String
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].return_data #=> Boolean
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0].period #=> Integer
resp.slo.request_based_sli.request_based_sli_metric.monitored_request_count_metric.bad_count_metric[0]. #=> String
resp.slo.request_based_sli.metric_threshold #=> Float
resp.slo.request_based_sli.comparison_operator #=> String, one of "GreaterThanOrEqualTo", "GreaterThan", "LessThan", "LessThanOrEqualTo"
resp.slo.evaluation_type #=> String, one of "PeriodBased", "RequestBased"
resp.slo.goal.interval.rolling_interval.duration_unit #=> String, one of "MINUTE", "HOUR", "DAY", "MONTH"
resp.slo.goal.interval.rolling_interval.duration #=> Integer
resp.slo.goal.interval.calendar_interval.start_time #=> Time
resp.slo.goal.interval.calendar_interval.duration_unit #=> String, one of "MINUTE", "HOUR", "DAY", "MONTH"
resp.slo.goal.interval.calendar_interval.duration #=> Integer
resp.slo.goal.attainment_goal #=> Float
resp.slo.goal.warning_threshold #=> Float
resp.slo.burn_rate_configurations #=> Array
resp.slo.burn_rate_configurations[0].look_back_window_minutes #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The Amazon Resource Name (ARN) or name of the service level objective that you want to update.

  • :description (String) —

    An optional description for the SLO.

  • :sli_config (Types::ServiceLevelIndicatorConfig) —

    If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.

  • :request_based_sli_config (Types::RequestBasedServiceLevelIndicatorConfig) —

    If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.

    You can't specify both SliConfig and RequestBasedSliConfig in the same operation.

  • :goal (Types::Goal) —

    A structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold.

  • :burn_rate_configurations (Array<Types::BurnRateConfiguration>) —

    Use this array to create burn rates for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.

Returns:

See Also:



2117
2118
2119
2120
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 2117

def update_service_level_objective(params = {}, options = {})
  req = build_request(:update_service_level_objective, params)
  req.send_request(options)
end