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 used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :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 —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :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_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :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.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :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) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or 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.



471
472
473
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 471

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.sli_metric.dependency_config.dependency_key_attributes #=> Hash
resp.reports[0].sli.sli_metric.dependency_config.dependency_key_attributes["KeyAttributeName"] #=> String
resp.reports[0].sli.sli_metric.dependency_config.dependency_operation_name #=> String
resp.reports[0].sli.sli_metric.metric_source.metric_source_key_attributes #=> Hash
resp.reports[0].sli.sli_metric.metric_source.metric_source_key_attributes["KeyAttributeName"] #=> String
resp.reports[0].sli.sli_metric.metric_source.metric_source_attributes #=> Hash
resp.reports[0].sli.sli_metric.metric_source.metric_source_attributes["KeyAttributeName"] #=> String
resp.reports[0].sli.sli_metric.composite_sli_config.selection_config.type #=> String, one of "EXPLICIT", "PREFIX", "REGEX"
resp.reports[0].sli.sli_metric.composite_sli_config.selection_config.pattern #=> String
resp.reports[0].sli.sli_metric.composite_sli_config.components #=> Array
resp.reports[0].sli.sli_metric.composite_sli_config.components[0].operation_name #=> 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.request_based_sli_metric.dependency_config.dependency_key_attributes #=> Hash
resp.reports[0].request_based_sli.request_based_sli_metric.dependency_config.dependency_key_attributes["KeyAttributeName"] #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.dependency_config.dependency_operation_name #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.metric_source.metric_source_key_attributes #=> Hash
resp.reports[0].request_based_sli.request_based_sli_metric.metric_source.metric_source_key_attributes["KeyAttributeName"] #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.metric_source.metric_source_attributes #=> Hash
resp.reports[0].request_based_sli.request_based_sli_metric.metric_source.metric_source_attributes["KeyAttributeName"] #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.composite_sli_config.selection_config.type #=> String, one of "EXPLICIT", "PREFIX", "REGEX"
resp.reports[0].request_based_sli.request_based_sli_metric.composite_sli_config.selection_config.pattern #=> String
resp.reports[0].request_based_sli.request_based_sli_metric.composite_sli_config.components #=> Array
resp.reports[0].request_based_sli.request_based_sli_metric.composite_sli_config.components[0].operation_name #=> 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:



641
642
643
644
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 641

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

#batch_update_exclusion_windows(params = {}) ⇒ Types::BatchUpdateExclusionWindowsOutput

Add or remove time window exclusions for one or more Service Level Objectives (SLOs).

Examples:

Request syntax with placeholder values


resp = client.batch_update_exclusion_windows({
  slo_ids: ["String"], # required
  add_exclusion_windows: [
    {
      window: { # required
        duration_unit: "MINUTE", # required, accepts MINUTE, HOUR, DAY, MONTH
        duration: 1, # required
      },
      start_time: Time.now,
      recurrence_rule: {
        expression: "Expression", # required
      },
      reason: "ExclusionReason",
    },
  ],
  remove_exclusion_windows: [
    {
      window: { # required
        duration_unit: "MINUTE", # required, accepts MINUTE, HOUR, DAY, MONTH
        duration: 1, # required
      },
      start_time: Time.now,
      recurrence_rule: {
        expression: "Expression", # required
      },
      reason: "ExclusionReason",
    },
  ],
})

Response structure


resp.slo_ids #=> Array
resp.slo_ids[0] #=> String
resp.errors #=> Array
resp.errors[0].slo_id #=> String
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    The list of SLO IDs to add or remove exclusion windows from.

  • :add_exclusion_windows (Array<Types::ExclusionWindow>) —

    A list of exclusion windows to add to the specified SLOs. You can add up to 10 exclusion windows per SLO.

  • :remove_exclusion_windows (Array<Types::ExclusionWindow>) —

    A list of exclusion windows to remove from the specified SLOs. The window configuration must match an existing exclusion window.

Returns:

See Also:



710
711
712
713
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 710

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

You can't create an SLO for a service operation that was discovered by Application Signals until after that operation has reported standard metrics to Application Signals.

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
      metric_name: "MetricName",
      statistic: "ServiceLevelIndicatorStatistic",
      period_seconds: 1,
      metric_source: {
        metric_source_key_attributes: { # required
          "KeyAttributeName" => "KeyAttributeValue",
        },
        metric_source_attributes: {
          "KeyAttributeName" => "KeyAttributeValue",
        },
      },
      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",
        },
      ],
      dependency_config: {
        dependency_key_attributes: { # required
          "KeyAttributeName" => "KeyAttributeValue",
        },
        dependency_operation_name: "OperationName", # required
      },
      composite_sli_config: {
        selection_config: { # required
          type: "EXPLICIT", # required, accepts EXPLICIT, PREFIX, REGEX
          pattern: "SelectionPattern",
        },
        components: [
          {
            operation_name: "OperationName",
          },
        ],
      },
    },
    metric_threshold: 1.0,
    comparison_operator: "GreaterThanOrEqualTo", # 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",
          },
        ],
      },
      dependency_config: {
        dependency_key_attributes: { # required
          "KeyAttributeName" => "KeyAttributeValue",
        },
        dependency_operation_name: "OperationName", # required
      },
      metric_source: {
        metric_source_key_attributes: { # required
          "KeyAttributeName" => "KeyAttributeValue",
        },
        metric_source_attributes: {
          "KeyAttributeName" => "KeyAttributeValue",
        },
      },
      metric_name: "MetricName",
      composite_sli_config: {
        selection_config: { # required
          type: "EXPLICIT", # required, accepts EXPLICIT, PREFIX, REGEX
          pattern: "SelectionPattern",
        },
        components: [
          {
            operation_name: "OperationName",
          },
        ],
      },
    },
    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
    },
  ],
  create_recommended_slo: false,
  auto_investigation_enabled: false,
})

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.sli_metric.dependency_config.dependency_key_attributes #=> Hash
resp.slo.sli.sli_metric.dependency_config.dependency_key_attributes["KeyAttributeName"] #=> String
resp.slo.sli.sli_metric.dependency_config.dependency_operation_name #=> String
resp.slo.sli.sli_metric.metric_source.metric_source_key_attributes #=> Hash
resp.slo.sli.sli_metric.metric_source.metric_source_key_attributes["KeyAttributeName"] #=> String
resp.slo.sli.sli_metric.metric_source.metric_source_attributes #=> Hash
resp.slo.sli.sli_metric.metric_source.metric_source_attributes["KeyAttributeName"] #=> String
resp.slo.sli.sli_metric.composite_sli_config.selection_config.type #=> String, one of "EXPLICIT", "PREFIX", "REGEX"
resp.slo.sli.sli_metric.composite_sli_config.selection_config.pattern #=> String
resp.slo.sli.sli_metric.composite_sli_config.components #=> Array
resp.slo.sli.sli_metric.composite_sli_config.components[0].operation_name #=> 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.request_based_sli_metric.dependency_config.dependency_key_attributes #=> Hash
resp.slo.request_based_sli.request_based_sli_metric.dependency_config.dependency_key_attributes["KeyAttributeName"] #=> String
resp.slo.request_based_sli.request_based_sli_metric.dependency_config.dependency_operation_name #=> String
resp.slo.request_based_sli.request_based_sli_metric.metric_source.metric_source_key_attributes #=> Hash
resp.slo.request_based_sli.request_based_sli_metric.metric_source.metric_source_key_attributes["KeyAttributeName"] #=> String
resp.slo.request_based_sli.request_based_sli_metric.metric_source.metric_source_attributes #=> Hash
resp.slo.request_based_sli.request_based_sli_metric.metric_source.metric_source_attributes["KeyAttributeName"] #=> String
resp.slo.request_based_sli.request_based_sli_metric.composite_sli_config.selection_config.type #=> String, one of "EXPLICIT", "PREFIX", "REGEX"
resp.slo.request_based_sli.request_based_sli_metric.composite_sli_config.selection_config.pattern #=> String
resp.slo.request_based_sli.request_based_sli_metric.composite_sli_config.components #=> Array
resp.slo.request_based_sli.request_based_sli_metric.composite_sli_config.components[0].operation_name #=> 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
resp.slo.metric_source_type #=> String, one of "ServiceOperation", "CloudWatchMetric", "ServiceDependency", "AppMonitor", "Canary", "Service"
resp.slo.auto_investigation_enabled #=> Boolean

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.

  • :create_recommended_slo (Boolean) —

    Set this to true to create a recommended SLO out of the box. When set to true, you don't need to specify the MetricThreshold or ComparisonOperator in the SliConfig or RequestBasedSliConfig. The default value is false.

    This is supported for SLOs on a service, service operation, or a dependency.

  • :auto_investigation_enabled (Boolean) —

    Indicates whether DevOps Agent will automatically investigate this SLO when it is breached

Returns:

See Also:



1195
1196
1197
1198
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1195

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

#delete_grouping_configuration(params = {}) ⇒ Struct

Deletes the grouping configuration for this account. This removes all custom grouping attribute definitions that were previously configured.

Parameters:

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

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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



1231
1232
1233
1234
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1231

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.service_groups #=> Array
resp.service.service_groups[0].group_name #=> String
resp.service.service_groups[0].group_value #=> String
resp.service.service_groups[0].group_source #=> String
resp.service.service_groups[0].group_identifier #=> 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.metric_references[0]. #=> 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:



1326
1327
1328
1329
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1326

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.sli_metric.dependency_config.dependency_key_attributes #=> Hash
resp.slo.sli.sli_metric.dependency_config.dependency_key_attributes["KeyAttributeName"] #=> String
resp.slo.sli.sli_metric.dependency_config.dependency_operation_name #=> String
resp.slo.sli.sli_metric.metric_source.metric_source_key_attributes #=> Hash
resp.slo.sli.sli_metric.metric_source.metric_source_key_attributes["KeyAttributeName"] #=> String
resp.slo.sli.sli_metric.metric_source.metric_source_attributes #=> Hash
resp.slo.sli.sli_metric.metric_source.metric_source_attributes["KeyAttributeName"] #=> String
resp.slo.sli.sli_metric.composite_sli_config.selection_config.type #=> String, one of "EXPLICIT", "PREFIX", "REGEX"
resp.slo.sli.sli_metric.composite_sli_config.selection_config.pattern #=> String
resp.slo.sli.sli_metric.composite_sli_config.components #=> Array
resp.slo.sli.sli_metric.composite_sli_config.components[0].operation_name #=> 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.request_based_sli_metric.dependency_config.dependency_key_attributes #=> Hash
resp.slo.request_based_sli.request_based_sli_metric.dependency_config.dependency_key_attributes["KeyAttributeName"] #=> String
resp.slo.request_based_sli.request_based_sli_metric.dependency_config.dependency_operation_name #=> String
resp.slo.request_based_sli.request_based_sli_metric.metric_source.metric_source_key_attributes #=> Hash
resp.slo.request_based_sli.request_based_sli_metric.metric_source.metric_source_key_attributes["KeyAttributeName"] #=> String
resp.slo.request_based_sli.request_based_sli_metric.metric_source.metric_source_attributes #=> Hash
resp.slo.request_based_sli.request_based_sli_metric.metric_source.metric_source_attributes["KeyAttributeName"] #=> String
resp.slo.request_based_sli.request_based_sli_metric.composite_sli_config.selection_config.type #=> String, one of "EXPLICIT", "PREFIX", "REGEX"
resp.slo.request_based_sli.request_based_sli_metric.composite_sli_config.selection_config.pattern #=> String
resp.slo.request_based_sli.request_based_sli_metric.composite_sli_config.components #=> Array
resp.slo.request_based_sli.request_based_sli_metric.composite_sli_config.components[0].operation_name #=> 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
resp.slo.metric_source_type #=> String, one of "ServiceOperation", "CloudWatchMetric", "ServiceDependency", "AppMonitor", "Canary", "Service"
resp.slo.auto_investigation_enabled #=> Boolean

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:



1470
1471
1472
1473
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1470

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

#list_audit_findings(params = {}) ⇒ Types::ListAuditFindingsOutput

Returns a list of audit findings that provide automated analysis of service behavior and root cause analysis. These findings help identify the most significant observations about your services, including performance issues, anomalies, and potential problems. The findings are generated using heuristic algorithms based on established troubleshooting patterns.

Examples:

Request syntax with placeholder values


resp = client.list_audit_findings({
  start_time: Time.now, # required
  end_time: Time.now, # required
  auditors: ["String"],
  audit_targets: [ # required
    {
      type: "String", # required
      data: { # required
        service: {
          type: "String",
          name: "String",
          environment: "String",
          aws_account_id: "String",
        },
        slo: {
          slo_name: "String",
          slo_arn: "String",
        },
        service_operation: {
          service: {
            type: "String",
            name: "String",
            environment: "String",
            aws_account_id: "String",
          },
          operation: "String",
          metric_type: "String",
        },
        canary: {
          canary_name: "String", # required
        },
      },
    },
  ],
  detail_level: "BRIEF", # accepts BRIEF, DETAILED
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.start_time #=> Time
resp.end_time #=> Time
resp.audit_findings #=> Array
resp.audit_findings[0].key_attributes #=> Hash
resp.audit_findings[0].key_attributes["KeyAttributeName"] #=> String
resp.audit_findings[0].auditor_results #=> Array
resp.audit_findings[0].auditor_results[0].auditor #=> String
resp.audit_findings[0].auditor_results[0].description #=> String
resp.audit_findings[0].auditor_results[0].data #=> Hash
resp.audit_findings[0].auditor_results[0].data["String"] #=> String
resp.audit_findings[0].auditor_results[0].severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW", "NONE"
resp.audit_findings[0].operation #=> String
resp.audit_findings[0].metric_graph.metric_data_queries #=> Array
resp.audit_findings[0].metric_graph.metric_data_queries[0].id #=> String
resp.audit_findings[0].metric_graph.metric_data_queries[0].metric_stat.metric.namespace #=> String
resp.audit_findings[0].metric_graph.metric_data_queries[0].metric_stat.metric.metric_name #=> String
resp.audit_findings[0].metric_graph.metric_data_queries[0].metric_stat.metric.dimensions #=> Array
resp.audit_findings[0].metric_graph.metric_data_queries[0].metric_stat.metric.dimensions[0].name #=> String
resp.audit_findings[0].metric_graph.metric_data_queries[0].metric_stat.metric.dimensions[0].value #=> String
resp.audit_findings[0].metric_graph.metric_data_queries[0].metric_stat.period #=> Integer
resp.audit_findings[0].metric_graph.metric_data_queries[0].metric_stat.stat #=> String
resp.audit_findings[0].metric_graph.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.audit_findings[0].metric_graph.metric_data_queries[0].expression #=> String
resp.audit_findings[0].metric_graph.metric_data_queries[0].label #=> String
resp.audit_findings[0].metric_graph.metric_data_queries[0].return_data #=> Boolean
resp.audit_findings[0].metric_graph.metric_data_queries[0].period #=> Integer
resp.audit_findings[0].metric_graph.metric_data_queries[0]. #=> String
resp.audit_findings[0].metric_graph.start_time #=> Time
resp.audit_findings[0].metric_graph.end_time #=> Time
resp.audit_findings[0].dependency_graph.nodes #=> Array
resp.audit_findings[0].dependency_graph.nodes[0].key_attributes #=> Hash
resp.audit_findings[0].dependency_graph.nodes[0].key_attributes["KeyAttributeName"] #=> String
resp.audit_findings[0].dependency_graph.nodes[0].name #=> String
resp.audit_findings[0].dependency_graph.nodes[0].node_id #=> String
resp.audit_findings[0].dependency_graph.nodes[0].operation #=> String
resp.audit_findings[0].dependency_graph.nodes[0].type #=> String
resp.audit_findings[0].dependency_graph.nodes[0].duration #=> Float
resp.audit_findings[0].dependency_graph.nodes[0].status #=> String
resp.audit_findings[0].dependency_graph.edges #=> Array
resp.audit_findings[0].dependency_graph.edges[0].source_node_id #=> String
resp.audit_findings[0].dependency_graph.edges[0].destination_node_id #=> String
resp.audit_findings[0].dependency_graph.edges[0].duration #=> Float
resp.audit_findings[0].dependency_graph.edges[0].connection_type #=> String, one of "INDIRECT", "DIRECT"
resp.audit_findings[0].type #=> 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 audit findings for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057

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

    The end of the time period to retrieve audit findings for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057

  • :auditors (Array<String>) —

    A list of auditor names to filter the findings by. Only findings generated by the specified auditors will be returned.

    The following auditors are available for configuration:

    • slo - SloAuditor: Identifies SLO violations and detects breached thresholds during the Assessment phase.

    • operation_metric - OperationMetricAuditor: Detects anomalies in service operation metrics from Application Signals RED metrics during the Assessment phase

      Anomaly detection is not supported for sparse metrics (those missing more than 80% of datapoints within the given time period).

    • service_quota - ServiceQuotaAuditor: Monitors resource utilization against service quotas during the Assessment phase

    • trace - TraceAuditor: Performs deep-dive analysis of distributed traces, correlating traces with breached SLOs or abnormal RED metrics during the Analysis phase

    • dependency_metric - CriticalPathAuditor: Analyzes service dependency impacts and maps dependency relationships from Application Signals RED metrics during the Analysis phase

    • top_contributor - TopContributorAuditor: Identifies infrastructure-level contributors to issues by analyzing EMF logs of Application Signals RED metrics during the Analysis phase

    • log - LogAuditor: Extracts insights from application logs, categorizing error types and ranking severity by frequency during the Analysis phase

    • change_indicator - ChangeIndicatorAuditor: Detects change events (deployments, configuration changes) that occurred within 10 minutes before and during a detected anomaly, and surfaces them as findings with deployment timestamps in the Analysis phase. When changes are detected, the top_contributor auditor skips its analysis to avoid redundancy.

    InitAuditor and Summarizer auditors are not configurable as they are automatically triggered during the audit process.

  • :audit_targets (required, Array<Types::AuditTarget>) —

    A list of audit targets to filter the findings by. You can specify services, SLOs, or service operations to limit the audit findings to specific entities.

  • :detail_level (String) —

    The level of details of the audit findings. Supported values: BRIEF, DETAILED.

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



1658
1659
1660
1661
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1658

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

#list_entity_events(params = {}) ⇒ Types::ListEntityEventsOutput

Returns a list of change events for a specific entity, such as deployments, configuration changes, or other state-changing activities. This operation helps track the history of changes that may have affected service performance.

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_entity_events({
  entity: { # required
    "KeyAttributeName" => "KeyAttributeValue",
  },
  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.change_events #=> Array
resp.change_events[0].timestamp #=> Time
resp.change_events[0]. #=> String
resp.change_events[0].region #=> String
resp.change_events[0].entity #=> Hash
resp.change_events[0].entity["KeyAttributeName"] #=> String
resp.change_events[0].change_event_type #=> String, one of "DEPLOYMENT", "CONFIGURATION"
resp.change_events[0].event_id #=> String
resp.change_events[0].user_name #=> String
resp.change_events[0].event_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    The entity for which to retrieve change events. This specifies the service, resource, or other entity whose event history you want to examine.

    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.

    • AwsAccountId specifies the account where this object is in.

    Below is an example of a service.

    { "Type": "Service", "Name": "visits-service", "Environment": "petclinic-test" }

    Below is an example of a resource.

    { "Type": "AWS::Resource", "ResourceType": "AWS::DynamoDB::Table", "Identifier": "Customers" }

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

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

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

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

  • :max_results (Integer) —

    The maximum number of change events 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 change events.

Returns:

See Also:



1763
1764
1765
1766
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1763

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

#list_grouping_attribute_definitions(params = {}) ⇒ Types::ListGroupingAttributeDefinitionsOutput

Returns the current grouping configuration for this account, including all custom grouping attribute definitions that have been configured. These definitions determine how services are logically grouped based on telemetry attributes, Amazon Web Services tags, or predefined mappings.

Examples:

Request syntax with placeholder values


resp = client.list_grouping_attribute_definitions({
  next_token: "NextToken",
  aws_account_id: "AwsAccountId",
  include_linked_accounts: false,
})

Response structure


resp.grouping_attribute_definitions #=> Array
resp.grouping_attribute_definitions[0].grouping_name #=> String
resp.grouping_attribute_definitions[0].grouping_source_keys #=> Array
resp.grouping_attribute_definitions[0].grouping_source_keys[0] #=> String
resp.grouping_attribute_definitions[0].default_grouping_value #=> String
resp.updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

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

  • :aws_account_id (String) —

    The Amazon Web Services account ID to retrieve grouping attribute definitions for. Use this when accessing grouping configurations from a different account in cross-account monitoring scenarios.

  • :include_linked_accounts (Boolean) —

    If you are using this operation in a monitoring account, specify true to include grouping attributes from source accounts in the returned data.

Returns:

See Also:



1816
1817
1818
1819
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1816

def list_grouping_attribute_definitions(params = {}, options = {})
  req = build_request(:list_grouping_attribute_definitions, 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.service_dependencies[0].metric_references[0]. #=> 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:



1917
1918
1919
1920
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 1917

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.service_dependents[0].metric_references[0]. #=> 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:



2017
2018
2019
2020
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 2017

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

#list_service_level_objective_exclusion_windows(params = {}) ⇒ Types::ListServiceLevelObjectiveExclusionWindowsOutput

Retrieves all exclusion windows configured for a specific SLO.

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_objective_exclusion_windows({
  id: "ServiceLevelObjectiveId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.exclusion_windows #=> Array
resp.exclusion_windows[0].window.duration_unit #=> String, one of "MINUTE", "HOUR", "DAY", "MONTH"
resp.exclusion_windows[0].window.duration #=> Integer
resp.exclusion_windows[0].start_time #=> Time
resp.exclusion_windows[0].recurrence_rule.expression #=> String
resp.exclusion_windows[0].reason #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the SLO to list exclusion windows for.

  • :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:



2064
2065
2066
2067
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 2064

def list_service_level_objective_exclusion_windows(params = {}, options = {})
  req = build_request(:list_service_level_objective_exclusion_windows, 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",
  dependency_config: {
    dependency_key_attributes: { # required
      "KeyAttributeName" => "KeyAttributeValue",
    },
    dependency_operation_name: "OperationName", # required
  },
  max_results: 1,
  next_token: "NextToken",
  metric_source_types: ["ServiceOperation"], # accepts ServiceOperation, CloudWatchMetric, ServiceDependency, AppMonitor, Canary, Service
  include_linked_accounts: false,
  slo_owner_aws_account_id: "AwsAccountId",
  metric_source: {
    metric_source_key_attributes: { # required
      "KeyAttributeName" => "KeyAttributeValue",
    },
    metric_source_attributes: {
      "KeyAttributeName" => "KeyAttributeValue",
    },
  },
})

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].dependency_config.dependency_key_attributes #=> Hash
resp.slo_summaries[0].dependency_config.dependency_key_attributes["KeyAttributeName"] #=> String
resp.slo_summaries[0].dependency_config.dependency_operation_name #=> String
resp.slo_summaries[0].created_time #=> Time
resp.slo_summaries[0].evaluation_type #=> String, one of "PeriodBased", "RequestBased"
resp.slo_summaries[0].metric_source_type #=> String, one of "ServiceOperation", "CloudWatchMetric", "ServiceDependency", "AppMonitor", "Canary", "Service"
resp.slo_summaries[0].metric_source.metric_source_key_attributes #=> Hash
resp.slo_summaries[0].metric_source.metric_source_key_attributes["KeyAttributeName"] #=> String
resp.slo_summaries[0].metric_source.metric_source_attributes #=> Hash
resp.slo_summaries[0].metric_source.metric_source_attributes["KeyAttributeName"] #=> String
resp.slo_summaries[0].composite_sli_config.selection_config.type #=> String, one of "EXPLICIT", "PREFIX", "REGEX"
resp.slo_summaries[0].composite_sli_config.selection_config.pattern #=> String
resp.slo_summaries[0].composite_sli_config.components #=> Array
resp.slo_summaries[0].composite_sli_config.components[0].operation_name #=> String
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.

  • :dependency_config (Types::DependencyConfig) —

    Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

  • :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.

  • :metric_source_types (Array<String>) —

    Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:

    • Service operation

    • Service dependency

    • Service

    • CloudWatch metric

    • AppMonitor

    • Canary

  • :include_linked_accounts (Boolean) —

    If you are using this operation in a monitoring account, specify true to include SLO from source accounts in the returned data.

    When you are monitoring an account, you can use Amazon Web Services account ID in KeyAttribute filter for service source account and SloOwnerawsaccountID for SLO source account with IncludeLinkedAccounts to filter the returned data to only a single source account.

  • :slo_owner_aws_account_id (String) —

    SLO's Amazon Web Services account ID.

  • :metric_source (Types::MetricSource) —

    Identifies the metric source to filter SLOs by.

Returns:

See Also:



2204
2205
2206
2207
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 2204

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.service_operations[0].metric_references[0]. #=> 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:



2300
2301
2302
2303
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 2300

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

#list_service_states(params = {}) ⇒ Types::ListServiceStatesOutput

Returns information about the last deployment and other change states of services. This API provides visibility into recent changes that may have affected service performance, helping with troubleshooting and change correlation.

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_states({
  start_time: Time.now, # required
  end_time: Time.now, # required
  max_results: 1,
  next_token: "NextToken",
  include_linked_accounts: false,
  aws_account_id: "AwsAccountId",
  attribute_filters: [
    {
      attribute_filter_name: "AttributeFilterName", # required
      attribute_filter_values: ["AttributeFilterValue"], # required
    },
  ],
})

Response structure


resp.start_time #=> Time
resp.end_time #=> Time
resp.service_states #=> Array
resp.service_states[0].attribute_filters #=> Array
resp.service_states[0].attribute_filters[0].attribute_filter_name #=> String
resp.service_states[0].attribute_filters[0].attribute_filter_values #=> Array
resp.service_states[0].attribute_filters[0].attribute_filter_values[0] #=> String
resp.service_states[0].service #=> Hash
resp.service_states[0].service["KeyAttributeName"] #=> String
resp.service_states[0].latest_change_events #=> Array
resp.service_states[0].latest_change_events[0].timestamp #=> Time
resp.service_states[0].latest_change_events[0]. #=> String
resp.service_states[0].latest_change_events[0].region #=> String
resp.service_states[0].latest_change_events[0].entity #=> Hash
resp.service_states[0].latest_change_events[0].entity["KeyAttributeName"] #=> String
resp.service_states[0].latest_change_events[0].change_event_type #=> String, one of "DEPLOYMENT", "CONFIGURATION"
resp.service_states[0].latest_change_events[0].event_id #=> String
resp.service_states[0].latest_change_events[0].user_name #=> String
resp.service_states[0].latest_change_events[0].event_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 service state information for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057.

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

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

  • :max_results (Integer) —

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

  • :next_token (String) —

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

  • :include_linked_accounts (Boolean) —

    If you are using this operation in a monitoring account, specify true to include service states from source accounts in the returned data.

  • :aws_account_id (String) —

    The Amazon Web Services account ID to filter service states by. Use this to limit results to services from a specific account.

  • :attribute_filters (Array<Types::AttributeFilter>) —

    A list of attribute filters to narrow down the services. You can filter by platform, environment, or other service attributes.

Returns:

See Also:



2394
2395
2396
2397
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 2394

def list_service_states(params = {}, options = {})
  req = build_request(:list_service_states, 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",
  include_linked_accounts: false,
  aws_account_id: "AwsAccountId",
})

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.service_summaries[0].metric_references[0]. #=> String
resp.service_summaries[0].service_groups #=> Array
resp.service_summaries[0].service_groups[0].group_name #=> String
resp.service_summaries[0].service_groups[0].group_value #=> String
resp.service_summaries[0].service_groups[0].group_source #=> String
resp.service_summaries[0].service_groups[0].group_identifier #=> 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.

  • :include_linked_accounts (Boolean) —

    If you are using this operation in a monitoring account, specify true to include services from source accounts in the returned data.

  • :aws_account_id (String) —

    Amazon Web Services Account ID.

Returns:

See Also:



2482
2483
2484
2485
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 2482

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:



2524
2525
2526
2527
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 2524

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

#put_grouping_configuration(params = {}) ⇒ Types::PutGroupingConfigurationOutput

Creates or updates the grouping configuration for this account. This operation allows you to define custom grouping attributes that determine how services are logically grouped based on telemetry attributes, Amazon Web Services tags, or predefined mappings. These grouping attributes can then be used to organize and filter services in the Application Signals console and APIs.

Examples:

Request syntax with placeholder values


resp = client.put_grouping_configuration({
  grouping_attribute_definitions: [ # required
    {
      grouping_name: "GroupingString", # required
      grouping_source_keys: ["GroupingString"],
      default_grouping_value: "GroupingString",
    },
  ],
})

Response structure


resp.grouping_configuration.grouping_attribute_definitions #=> Array
resp.grouping_configuration.grouping_attribute_definitions[0].grouping_name #=> String
resp.grouping_configuration.grouping_attribute_definitions[0].grouping_source_keys #=> Array
resp.grouping_configuration.grouping_attribute_definitions[0].grouping_source_keys[0] #=> String
resp.grouping_configuration.grouping_attribute_definitions[0].default_grouping_value #=> String
resp.grouping_configuration.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :grouping_attribute_definitions (required, Array<Types::GroupingAttributeDefinition>) —

    An array of grouping attribute definitions that specify how services should be grouped. Each definition includes a friendly name, source keys to derive the grouping value from, and an optional default value.

Returns:

See Also:



2570
2571
2572
2573
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 2570

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

A service-linked CloudTrail event channel is created to process CloudTrail events and return change event information. This includes last deployment time, userName, eventName, and other event metadata.

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:



2612
2613
2614
2615
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 2612

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:



2670
2671
2672
2673
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 2670

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:



2707
2708
2709
2710
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 2707

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
      metric_name: "MetricName",
      statistic: "ServiceLevelIndicatorStatistic",
      period_seconds: 1,
      metric_source: {
        metric_source_key_attributes: { # required
          "KeyAttributeName" => "KeyAttributeValue",
        },
        metric_source_attributes: {
          "KeyAttributeName" => "KeyAttributeValue",
        },
      },
      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",
        },
      ],
      dependency_config: {
        dependency_key_attributes: { # required
          "KeyAttributeName" => "KeyAttributeValue",
        },
        dependency_operation_name: "OperationName", # required
      },
      composite_sli_config: {
        selection_config: { # required
          type: "EXPLICIT", # required, accepts EXPLICIT, PREFIX, REGEX
          pattern: "SelectionPattern",
        },
        components: [
          {
            operation_name: "OperationName",
          },
        ],
      },
    },
    metric_threshold: 1.0,
    comparison_operator: "GreaterThanOrEqualTo", # 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",
          },
        ],
      },
      dependency_config: {
        dependency_key_attributes: { # required
          "KeyAttributeName" => "KeyAttributeValue",
        },
        dependency_operation_name: "OperationName", # required
      },
      metric_source: {
        metric_source_key_attributes: { # required
          "KeyAttributeName" => "KeyAttributeValue",
        },
        metric_source_attributes: {
          "KeyAttributeName" => "KeyAttributeValue",
        },
      },
      metric_name: "MetricName",
      composite_sli_config: {
        selection_config: { # required
          type: "EXPLICIT", # required, accepts EXPLICIT, PREFIX, REGEX
          pattern: "SelectionPattern",
        },
        components: [
          {
            operation_name: "OperationName",
          },
        ],
      },
    },
    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
    },
  ],
  auto_investigation_enabled: false,
})

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.sli_metric.dependency_config.dependency_key_attributes #=> Hash
resp.slo.sli.sli_metric.dependency_config.dependency_key_attributes["KeyAttributeName"] #=> String
resp.slo.sli.sli_metric.dependency_config.dependency_operation_name #=> String
resp.slo.sli.sli_metric.metric_source.metric_source_key_attributes #=> Hash
resp.slo.sli.sli_metric.metric_source.metric_source_key_attributes["KeyAttributeName"] #=> String
resp.slo.sli.sli_metric.metric_source.metric_source_attributes #=> Hash
resp.slo.sli.sli_metric.metric_source.metric_source_attributes["KeyAttributeName"] #=> String
resp.slo.sli.sli_metric.composite_sli_config.selection_config.type #=> String, one of "EXPLICIT", "PREFIX", "REGEX"
resp.slo.sli.sli_metric.composite_sli_config.selection_config.pattern #=> String
resp.slo.sli.sli_metric.composite_sli_config.components #=> Array
resp.slo.sli.sli_metric.composite_sli_config.components[0].operation_name #=> 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.request_based_sli_metric.dependency_config.dependency_key_attributes #=> Hash
resp.slo.request_based_sli.request_based_sli_metric.dependency_config.dependency_key_attributes["KeyAttributeName"] #=> String
resp.slo.request_based_sli.request_based_sli_metric.dependency_config.dependency_operation_name #=> String
resp.slo.request_based_sli.request_based_sli_metric.metric_source.metric_source_key_attributes #=> Hash
resp.slo.request_based_sli.request_based_sli_metric.metric_source.metric_source_key_attributes["KeyAttributeName"] #=> String
resp.slo.request_based_sli.request_based_sli_metric.metric_source.metric_source_attributes #=> Hash
resp.slo.request_based_sli.request_based_sli_metric.metric_source.metric_source_attributes["KeyAttributeName"] #=> String
resp.slo.request_based_sli.request_based_sli_metric.composite_sli_config.selection_config.type #=> String, one of "EXPLICIT", "PREFIX", "REGEX"
resp.slo.request_based_sli.request_based_sli_metric.composite_sli_config.selection_config.pattern #=> String
resp.slo.request_based_sli.request_based_sli_metric.composite_sli_config.components #=> Array
resp.slo.request_based_sli.request_based_sli_metric.composite_sli_config.components[0].operation_name #=> 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
resp.slo.metric_source_type #=> String, one of "ServiceOperation", "CloudWatchMetric", "ServiceDependency", "AppMonitor", "Canary", "Service"
resp.slo.auto_investigation_enabled #=> Boolean

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.

  • :auto_investigation_enabled (Boolean) —

    Indicates whether DevOps Agent will automatically investigate this SLO when it is breached

Returns:

See Also:



3078
3079
3080
3081
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/client.rb', line 3078

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