Class: Aws::PrometheusService::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb

Overview

An API client for PrometheusService. To construct a client, you need to configure a :region and :credentials.

client = Aws::PrometheusService::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::PrometheusService::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::PrometheusService::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-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 471

def initialize(*args)
  super
end

Instance Method Details

#create_alert_manager_definition(params = {}) ⇒ Types::CreateAlertManagerDefinitionResponse

The CreateAlertManagerDefinition operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't use this operation to update it. Instead, use PutAlertManagerDefinition.

Examples:

Request syntax with placeholder values


resp = client.create_alert_manager_definition({
  workspace_id: "WorkspaceId", # required
  data: "data", # required
  client_token: "IdempotencyToken",
})

Response structure


resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
resp.status.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to add the alert manager definition to.

  • :data (required, String, StringIO, File) —

    The alert manager definition to add. A base64-encoded version of the YAML alert manager definition file.

    For details about the alert manager definition, see AlertManagedDefinitionData.

  • :client_token (String) —

    A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



524
525
526
527
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 524

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

#create_anomaly_detector(params = {}) ⇒ Types::CreateAnomalyDetectorResponse

Creates an anomaly detector within a workspace using the Random Cut Forest algorithm for time-series analysis. The anomaly detector analyzes Amazon Managed Service for Prometheus metrics to identify unusual patterns and behaviors.

Examples:

Request syntax with placeholder values


resp = client.create_anomaly_detector({
  workspace_id: "WorkspaceId", # required
  alias: "AnomalyDetectorAlias", # required
  evaluation_interval_in_seconds: 1,
  missing_data_action: {
    mark_as_anomaly: false,
    skip: false,
  },
  configuration: { # required
    random_cut_forest: {
      query: "RandomCutForestQuery", # required
      shingle_size: 1,
      sample_size: 1,
      ignore_near_expected_from_above: {
        amount: 1.0,
        ratio: 1.0,
      },
      ignore_near_expected_from_below: {
        amount: 1.0,
        ratio: 1.0,
      },
    },
  },
  labels: {
    "PrometheusMetricLabelKey" => "PrometheusMetricLabelValue",
  },
  client_token: "IdempotencyToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.anomaly_detector_id #=> String
resp.arn #=> String
resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
resp.status.status_reason #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The identifier of the workspace where the anomaly detector will be created.

  • :alias (required, String) —

    A user-friendly name for the anomaly detector.

  • :evaluation_interval_in_seconds (Integer) —

    The frequency, in seconds, at which the anomaly detector evaluates metrics. The default value is 60 seconds.

  • :missing_data_action (Types::AnomalyDetectorMissingDataAction) —

    Specifies the action to take when data is missing during evaluation.

  • :configuration (required, Types::AnomalyDetectorConfiguration) —

    The algorithm configuration for the anomaly detector.

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

    The Amazon Managed Service for Prometheus metric labels to associate with the anomaly detector.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

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

    The metadata to apply to the anomaly detector to assist with categorization and organization.

Returns:

See Also:



620
621
622
623
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 620

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

#create_logging_configuration(params = {}) ⇒ Types::CreateLoggingConfigurationResponse

The CreateLoggingConfiguration operation creates rules and alerting logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.

These logging configurations are only for rules and alerting logs.

Examples:

Request syntax with placeholder values


resp = client.create_logging_configuration({
  workspace_id: "WorkspaceId", # required
  log_group_arn: "LogGroupArn", # required
  client_token: "IdempotencyToken",
})

Response structure


resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
resp.status.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to create the logging configuration for.

  • :log_group_arn (required, String) —

    The ARN of the CloudWatch log group to which the vended log data will be published. This log group must exist prior to calling this operation.

  • :client_token (String) —

    A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



669
670
671
672
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 669

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

#create_query_logging_configuration(params = {}) ⇒ Types::CreateQueryLoggingConfigurationResponse

Creates a query logging configuration for the specified workspace. This operation enables logging of queries that exceed the specified QSP threshold.

Examples:

Request syntax with placeholder values


resp = client.create_query_logging_configuration({
  workspace_id: "WorkspaceId", # required
  destinations: [ # required
    {
      cloud_watch_logs: { # required
        log_group_arn: "LogGroupArn", # required
      },
      filters: { # required
        qsp_threshold: 1, # required
      },
    },
  ],
  client_token: "IdempotencyToken",
})

Response structure


resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
resp.status.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace for which to create the query logging configuration.

  • :destinations (required, Array<Types::LoggingDestination>) —

    The destinations where query logs will be sent. Only CloudWatch Logs destination is supported. The list must contain exactly one element.

  • :client_token (String) — default: Optional —

    A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



723
724
725
726
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 723

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

#create_rule_groups_namespace(params = {}) ⇒ Types::CreateRuleGroupsNamespaceResponse

The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.

The combined length of a rule group namespace and a rule group name cannot exceed 721 UTF-8 bytes.

Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use PutRuleGroupsNamespace.

Examples:

Request syntax with placeholder values


resp = client.create_rule_groups_namespace({
  workspace_id: "WorkspaceId", # required
  name: "RuleGroupsNamespaceName", # required
  data: "data", # required
  client_token: "IdempotencyToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.name #=> String
resp.arn #=> String
resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
resp.status.status_reason #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to add the rule groups namespace.

  • :name (required, String) —

    The name for the new rule groups namespace.

  • :data (required, String, StringIO, File) —

    The rules file to use in the new namespace.

    Contains the base64-encoded version of the YAML rules file.

    For details about the rule groups namespace structure, see RuleGroupsNamespaceData.

  • :client_token (String) —

    A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

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

    The list of tag keys and values to associate with the rule groups namespace.

Returns:

See Also:



801
802
803
804
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 801

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

#create_scraper(params = {}) ⇒ Types::CreateScraperResponse

Creates a scraper to collect metrics from Prometheus-compatible sources. The scraper sends the collected metrics to Amazon Managed Service for Prometheus workspaces or CloudWatch datasets. You can configure scrapers to collect metrics from Amazon EKS clusters, Amazon MSK clusters, or from VPC-based sources that support DNS-based service discovery. Scrapers are flexible. You can configure a scraper to control which metrics to collect, the frequency of collection, which transformations to apply to the metrics, and more.

An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your source. You must configure this role with a policy that allows it to scrape metrics from your source. For Amazon EKS sources, see Configuring your Amazon EKS cluster in the Amazon Managed Service for Prometheus User Guide.

The scrapeConfiguration parameter contains the base-64 encoded YAML configuration for the scraper.

When creating a scraper, the service creates a Network Interface in each Availability Zone that are passed into CreateScraper through subnets. These network interfaces are used to connect to your source within the VPC for scraping metrics.

For more information about collectors, including what metrics are collected, and how to configure the scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide.

Examples:

Example: CreateScraper with optional alias input, optional clientToken input, and one set of tags


resp = client.create_scraper({
  alias: "alias", 
  client_token: "token", 
  destination: {
    amp_configuration: {
      workspace_arn: "arn:aws:aps:us-west-2:123456789012:workspace/ws-ogh2u499-ce12-hg89-v6c7-123412341234", 
    }, 
  }, 
  scrape_configuration: {
    configuration_blob: "blob", 
  }, 
  source: {
    eks_configuration: {
      cluster_arn: "arn:aws:eks:us-west-2:123456789012:cluster/example", 
      security_group_ids: [
        "sg-abc123", 
      ], 
      subnet_ids: [
        "subnet-abc123", 
      ], 
    }, 
  }, 
  tags: {
    "exampleTag" => "exampleValue", 
  }, 
})

resp.to_h outputs the following:
{
  arn: "arn:aws:aps:us-west-2:123456789012:scraper/scraper-123", 
  scraper_id: "scraper-123", 
  status: {
    status_code: "CREATING", 
  }, 
  tags: {
    "exampleTag" => "exampleValue", 
  }, 
}

Example: CreateScraper with generic VPC config with mandatory securityGroupIds and subnetIds


resp = client.create_scraper({
  alias: "alias", 
  client_token: "token", 
  destination: {
    amp_configuration: {
      workspace_arn: "arn:aws:aps:us-west-2:123456789012:workspace/ws-ogh2u499-ce12-hg89-v6c7-123412341234", 
    }, 
  }, 
  scrape_configuration: {
    configuration_blob: "blob", 
  }, 
  source: {
    vpc_configuration: {
      security_group_ids: [
        "sg-abc123", 
      ], 
      subnet_ids: [
        "subnet-abc123", 
      ], 
    }, 
  }, 
  tags: {
    "exampleTag" => "exampleValue", 
  }, 
})

resp.to_h outputs the following:
{
  arn: "arn:aws:aps:us-west-2:123456789012:scraper/scraper-123", 
  scraper_id: "scraper-123", 
  status: {
    status_code: "CREATING", 
  }, 
  tags: {
    "exampleTag" => "exampleValue", 
  }, 
}

Request syntax with placeholder values


resp = client.create_scraper({
  alias: "ScraperAlias",
  scrape_configuration: { # required
    configuration_blob: "data",
  },
  source: { # required
    eks_configuration: {
      cluster_arn: "ClusterArn", # required
      security_group_ids: ["SecurityGroupId"],
      subnet_ids: ["SubnetId"], # required
    },
    vpc_configuration: {
      security_group_ids: ["SecurityGroupId"], # required
      subnet_ids: ["SubnetId"], # required
    },
  },
  destination: { # required
    amp_configuration: {
      workspace_arn: "WorkspaceArn", # required
    },
    cloud_watch_configuration: {
      dataset_arn: "CloudWatchDatasetArn", # required
    },
  },
  role_configuration: {
    source_role_arn: "IamRoleArn",
    target_role_arn: "IamRoleArn",
  },
  client_token: "IdempotencyToken",
  tags: {
    "TagKey" => "TagValue",
  },
  exporters: [
    {
      open_search_configuration: {
        domain_arn: "OpenSearchDomainArn", # required
      },
    },
  ],
})

Response structure


resp.scraper_id #=> String
resp.arn #=> String
resp.status.status_code #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :alias (String) — default: optional —

    An alias to associate with the scraper. This is for your use, and does not need to be unique.

  • :scrape_configuration (required, Types::ScrapeConfiguration) —

    The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.

  • :source (required, Types::Source) —

    The Amazon EKS or Amazon Web Services cluster from which the scraper will collect metrics.

  • :destination (required, Types::Destination) —

    The destination where the scraper sends the collected metrics. Valid destinations are Amazon Managed Service for Prometheus workspaces and CloudWatch datasets.

  • :role_configuration (Types::RoleConfiguration) —

    Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.

  • :client_token (String) — default: Optional —

    A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) — default: Optional —

    The list of tag keys and values to associate with the scraper.

  • :exporters (Array<Types::ExporterConfiguration>) —

    The exporter configurations for the scraper. You can configure at most one Amazon OpenSearch Service domain. If you don't specify a value, the scraper is created without an exporter configuration.

Returns:

See Also:



1028
1029
1030
1031
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1028

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

#create_workspace(params = {}) ⇒ Types::CreateWorkspaceResponse

Creates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.

Examples:

Request syntax with placeholder values


resp = client.create_workspace({
  alias: "WorkspaceAlias",
  client_token: "IdempotencyToken",
  tags: {
    "TagKey" => "TagValue",
  },
  kms_key_arn: "KmsKeyArn",
})

Response structure


resp.workspace_id #=> String
resp.arn #=> String
resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.kms_key_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :alias (String) —

    An alias that you assign to this workspace to help you identify it. It does not need to be unique.

    Blank spaces at the beginning or end of the alias that you specify will be trimmed from the value used.

  • :client_token (String) —

    A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

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

    The list of tag keys and values to associate with the workspace.

  • :kms_key_arn (String) — default: optional —

    The ARN for a customer managed KMS key to use for encrypting data within your workspace. For more information about using your own key in your workspace, see Encryption at rest in the Amazon Managed Service for Prometheus User Guide.

Returns:

See Also:



1096
1097
1098
1099
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1096

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

#delete_alert_manager_definition(params = {}) ⇒ Struct

Deletes the alert manager definition from a workspace.

Examples:

Request syntax with placeholder values


resp = client.delete_alert_manager_definition({
  workspace_id: "WorkspaceId", # required
  client_token: "IdempotencyToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to delete the alert manager definition from.

  • :client_token (String) —

    A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1126
1127
1128
1129
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1126

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

#delete_anomaly_detector(params = {}) ⇒ Struct

Removes an anomaly detector from a workspace. This operation is idempotent.

Examples:

Request syntax with placeholder values


resp = client.delete_anomaly_detector({
  workspace_id: "WorkspaceId", # required
  anomaly_detector_id: "AnomalyDetectorId", # required
  client_token: "IdempotencyToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The identifier of the workspace containing the anomaly detector to delete.

  • :anomaly_detector_id (required, String) —

    The identifier of the anomaly detector to delete.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1162
1163
1164
1165
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1162

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

#delete_logging_configuration(params = {}) ⇒ Struct

Deletes the rules and alerting logging configuration for a workspace.

These logging configurations are only for rules and alerting logs.

Examples:

Request syntax with placeholder values


resp = client.delete_logging_configuration({
  workspace_id: "WorkspaceId", # required
  client_token: "IdempotencyToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace containing the logging configuration to delete.

  • :client_token (String) —

    A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1197
1198
1199
1200
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1197

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

#delete_query_logging_configuration(params = {}) ⇒ Struct

Deletes the query logging configuration for the specified workspace.

Examples:

Request syntax with placeholder values


resp = client.delete_query_logging_configuration({
  workspace_id: "WorkspaceId", # required
  client_token: "IdempotencyToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace from which to delete the query logging configuration.

  • :client_token (String) — default: Optional —

    A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1228
1229
1230
1231
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1228

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

#delete_resource_policy(params = {}) ⇒ Struct

Deletes the resource-based policy attached to an Amazon Managed Service for Prometheus workspace.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_policy({
  workspace_id: "WorkspaceId", # required
  client_token: "IdempotencyToken",
  revision_id: "String",
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace from which to delete the resource-based policy.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the request is safe to retry (idempotent).

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :revision_id (String) —

    The revision ID of the policy to delete. Use this parameter to ensure that you are deleting the correct version of the policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1265
1266
1267
1268
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1265

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

#delete_rule_groups_namespace(params = {}) ⇒ Struct

Deletes one rule groups namespace and its associated rule groups definition.

Examples:

Request syntax with placeholder values


resp = client.delete_rule_groups_namespace({
  workspace_id: "WorkspaceId", # required
  name: "RuleGroupsNamespaceName", # required
  client_token: "IdempotencyToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace containing the rule groups namespace and definition to delete.

  • :name (required, String) —

    The name of the rule groups namespace to delete.

  • :client_token (String) —

    A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1301
1302
1303
1304
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1301

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

#delete_scraper(params = {}) ⇒ Types::DeleteScraperResponse

The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.

Examples:

Example: DeleteScraper with optional clientToken input


resp = client.delete_scraper({
  client_token: "token", 
  scraper_id: "scraper-123", 
})

resp.to_h outputs the following:
{
  scraper_id: "scraper-123", 
  status: {
    status_code: "DELETING", 
  }, 
}

Request syntax with placeholder values


resp = client.delete_scraper({
  scraper_id: "ScraperId", # required
  client_token: "IdempotencyToken",
})

Response structure


resp.scraper_id #=> String
resp.status.status_code #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :scraper_id (required, String) —

    The ID of the scraper to delete.

  • :client_token (String) — default: Optional —

    A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



1356
1357
1358
1359
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1356

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

#delete_scraper_logging_configuration(params = {}) ⇒ Struct

Deletes the logging configuration for a Amazon Managed Service for Prometheus scraper.

Examples:

Request syntax with placeholder values


resp = client.delete_scraper_logging_configuration({
  scraper_id: "ScraperId", # required
  client_token: "IdempotencyToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :scraper_id (required, String) —

    The ID of the scraper whose logging configuration will be deleted.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the request is processed exactly once.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1387
1388
1389
1390
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1387

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

#delete_workspace(params = {}) ⇒ Struct

Deletes an existing workspace.

When you delete a workspace, the data that has been ingested into it is not immediately deleted. It will be permanently deleted within one month.

Examples:

Request syntax with placeholder values


resp = client.delete_workspace({
  workspace_id: "WorkspaceId", # required
  client_token: "IdempotencyToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to delete.

  • :client_token (String) —

    A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1423
1424
1425
1426
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1423

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

#describe_alert_manager_definition(params = {}) ⇒ Types::DescribeAlertManagerDefinitionResponse

Retrieves the full information about the alert manager definition for a workspace.

Examples:

Request syntax with placeholder values


resp = client.describe_alert_manager_definition({
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.alert_manager_definition.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
resp.alert_manager_definition.status.status_reason #=> String
resp.alert_manager_definition.data #=> String
resp.alert_manager_definition.created_at #=> Time
resp.alert_manager_definition.modified_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to retrieve the alert manager definition from.

Returns:

See Also:



1456
1457
1458
1459
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1456

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

#describe_anomaly_detector(params = {}) ⇒ Types::DescribeAnomalyDetectorResponse

Retrieves detailed information about a specific anomaly detector, including its status and configuration.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • anomaly_detector_active
  • anomaly_detector_deleted

Examples:

Request syntax with placeholder values


resp = client.describe_anomaly_detector({
  workspace_id: "WorkspaceId", # required
  anomaly_detector_id: "AnomalyDetectorId", # required
})

Response structure


resp.anomaly_detector.arn #=> String
resp.anomaly_detector.anomaly_detector_id #=> String
resp.anomaly_detector.alias #=> String
resp.anomaly_detector.evaluation_interval_in_seconds #=> Integer
resp.anomaly_detector.missing_data_action.mark_as_anomaly #=> Boolean
resp.anomaly_detector.missing_data_action.skip #=> Boolean
resp.anomaly_detector.configuration.random_cut_forest.query #=> String
resp.anomaly_detector.configuration.random_cut_forest.shingle_size #=> Integer
resp.anomaly_detector.configuration.random_cut_forest.sample_size #=> Integer
resp.anomaly_detector.configuration.random_cut_forest.ignore_near_expected_from_above.amount #=> Float
resp.anomaly_detector.configuration.random_cut_forest.ignore_near_expected_from_above.ratio #=> Float
resp.anomaly_detector.configuration.random_cut_forest.ignore_near_expected_from_below.amount #=> Float
resp.anomaly_detector.configuration.random_cut_forest.ignore_near_expected_from_below.ratio #=> Float
resp.anomaly_detector.labels #=> Hash
resp.anomaly_detector.labels["PrometheusMetricLabelKey"] #=> String
resp.anomaly_detector.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
resp.anomaly_detector.status.status_reason #=> String
resp.anomaly_detector.created_at #=> Time
resp.anomaly_detector.modified_at #=> Time
resp.anomaly_detector.tags #=> Hash
resp.anomaly_detector.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The identifier of the workspace containing the anomaly detector.

  • :anomaly_detector_id (required, String) —

    The identifier of the anomaly detector to describe.

Returns:

See Also:



1515
1516
1517
1518
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1515

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

#describe_logging_configuration(params = {}) ⇒ Types::DescribeLoggingConfigurationResponse

Returns complete information about the current rules and alerting logging configuration of the workspace.

These logging configurations are only for rules and alerting logs.

Examples:

Request syntax with placeholder values


resp = client.describe_logging_configuration({
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.logging_configuration.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
resp.logging_configuration.status.status_reason #=> String
resp.logging_configuration.workspace #=> String
resp.logging_configuration.log_group_arn #=> String
resp.logging_configuration.created_at #=> Time
resp.logging_configuration.modified_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to describe the logging configuration for.

Returns:

See Also:



1553
1554
1555
1556
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1553

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

#describe_query_logging_configuration(params = {}) ⇒ Types::DescribeQueryLoggingConfigurationResponse

Retrieves the details of the query logging configuration for the specified workspace.

Examples:

Request syntax with placeholder values


resp = client.describe_query_logging_configuration({
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.query_logging_configuration.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
resp.query_logging_configuration.status.status_reason #=> String
resp.query_logging_configuration.workspace #=> String
resp.query_logging_configuration.destinations #=> Array
resp.query_logging_configuration.destinations[0].cloud_watch_logs.log_group_arn #=> String
resp.query_logging_configuration.destinations[0].filters.qsp_threshold #=> Integer
resp.query_logging_configuration.created_at #=> Time
resp.query_logging_configuration.modified_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace for which to retrieve the query logging configuration.

Returns:

See Also:



1590
1591
1592
1593
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1590

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

#describe_resource_policy(params = {}) ⇒ Types::DescribeResourcePolicyResponse

Returns information about the resource-based policy attached to an Amazon Managed Service for Prometheus workspace.

Examples:

Request syntax with placeholder values


resp = client.describe_resource_policy({
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.policy_document #=> String
resp.policy_status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING"
resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to describe the resource-based policy for.

Returns:

See Also:



1623
1624
1625
1626
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1623

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

#describe_rule_groups_namespace(params = {}) ⇒ Types::DescribeRuleGroupsNamespaceResponse

Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.

Examples:

Request syntax with placeholder values


resp = client.describe_rule_groups_namespace({
  workspace_id: "WorkspaceId", # required
  name: "RuleGroupsNamespaceName", # required
})

Response structure


resp.rule_groups_namespace.arn #=> String
resp.rule_groups_namespace.name #=> String
resp.rule_groups_namespace.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
resp.rule_groups_namespace.status.status_reason #=> String
resp.rule_groups_namespace.data #=> String
resp.rule_groups_namespace.created_at #=> Time
resp.rule_groups_namespace.modified_at #=> Time
resp.rule_groups_namespace.tags #=> Hash
resp.rule_groups_namespace.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace containing the rule groups namespace.

  • :name (required, String) —

    The name of the rule groups namespace that you want information for.

Returns:

See Also:



1665
1666
1667
1668
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1665

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

#describe_scraper(params = {}) ⇒ Types::DescribeScraperResponse

The DescribeScraper operation displays information about an existing scraper.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • scraper_active
  • scraper_deleted

Examples:

Example: DescribeScraper, with no statusReason to report


resp = client.describe_scraper({
  scraper_id: "scraper-123", 
})

resp.to_h outputs the following:
{
  scraper: {
    alias: "alias", 
    arn: "arn:aws:aps:us-west-2:123456789012:scraper/scraper-123", 
    created_at: Time.parse("2023-01-01T00:00:00Z"), 
    destination: {
      amp_configuration: {
        workspace_arn: "arn:aws:aps:us-west-2:123456789012:workspace/ws-ogh2u499-ce12-hg89-v6c7-123412341234", 
      }, 
    }, 
    last_modified_at: Time.parse("2020-01-02T00:00:00Z"), 
    role_arn: "arn:aws:iam::123456789012:role/exampleRole", 
    scrape_configuration: {
      configuration_blob: "blob", 
    }, 
    scraper_id: "scraper-123", 
    source: {
      eks_configuration: {
        cluster_arn: "arn:aws:eks:us-west-2:123456789012:cluster/example", 
        security_group_ids: [
          "sg-abc123", 
        ], 
        subnet_ids: [
          "subnet-abc123", 
        ], 
      }, 
    }, 
    status: {
      status_code: "ACTIVE", 
    }, 
    tags: {
      "exampleTag" => "exampleValue", 
    }, 
  }, 
}

Request syntax with placeholder values


resp = client.describe_scraper({
  scraper_id: "ScraperId", # required
})

Response structure


resp.scraper.alias #=> String
resp.scraper.scraper_id #=> String
resp.scraper.arn #=> String
resp.scraper.role_arn #=> String
resp.scraper.status.status_code #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
resp.scraper.created_at #=> Time
resp.scraper.last_modified_at #=> Time
resp.scraper.tags #=> Hash
resp.scraper.tags["TagKey"] #=> String
resp.scraper.status_reason #=> String
resp.scraper.scrape_configuration.configuration_blob #=> String
resp.scraper.source.eks_configuration.cluster_arn #=> String
resp.scraper.source.eks_configuration.security_group_ids #=> Array
resp.scraper.source.eks_configuration.security_group_ids[0] #=> String
resp.scraper.source.eks_configuration.subnet_ids #=> Array
resp.scraper.source.eks_configuration.subnet_ids[0] #=> String
resp.scraper.source.vpc_configuration.security_group_ids #=> Array
resp.scraper.source.vpc_configuration.security_group_ids[0] #=> String
resp.scraper.source.vpc_configuration.subnet_ids #=> Array
resp.scraper.source.vpc_configuration.subnet_ids[0] #=> String
resp.scraper.destination.amp_configuration.workspace_arn #=> String
resp.scraper.destination.cloud_watch_configuration.dataset_arn #=> String
resp.scraper.role_configuration.source_role_arn #=> String
resp.scraper.role_configuration.target_role_arn #=> String
resp.scraper.exporters #=> Array
resp.scraper.exporters[0].open_search_configuration.domain_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :scraper_id (required, String) —

    The ID of the scraper to describe.

Returns:

See Also:



1769
1770
1771
1772
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1769

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

#describe_scraper_logging_configuration(params = {}) ⇒ Types::DescribeScraperLoggingConfigurationResponse

Describes the logging configuration for a Amazon Managed Service for Prometheus scraper.

Examples:

Request syntax with placeholder values


resp = client.describe_scraper_logging_configuration({
  scraper_id: "ScraperId", # required
})

Response structure


resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
resp.status.status_reason #=> String
resp.scraper_id #=> String
resp.logging_destination.cloud_watch_logs.log_group_arn #=> String
resp.scraper_components #=> Array
resp.scraper_components[0].type #=> String, one of "SERVICE_DISCOVERY", "COLLECTOR", "EXPORTER"
resp.scraper_components[0].config.options #=> Hash
resp.scraper_components[0].config.options["String"] #=> String
resp.modified_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :scraper_id (required, String) —

    The ID of the scraper whose logging configuration will be described.

Returns:

See Also:



1810
1811
1812
1813
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1810

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

#describe_workspace(params = {}) ⇒ Types::DescribeWorkspaceResponse

Returns information about an existing workspace.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • workspace_active
  • workspace_deleted

Examples:

Request syntax with placeholder values


resp = client.describe_workspace({
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.workspace.workspace_id #=> String
resp.workspace.alias #=> String
resp.workspace.arn #=> String
resp.workspace.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED"
resp.workspace.prometheus_endpoint #=> String
resp.workspace.created_at #=> Time
resp.workspace.tags #=> Hash
resp.workspace.tags["TagKey"] #=> String
resp.workspace.kms_key_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to describe.

Returns:

See Also:



1852
1853
1854
1855
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1852

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

#describe_workspace_configuration(params = {}) ⇒ Types::DescribeWorkspaceConfigurationResponse

Use this operation to return information about the configuration of a workspace. The configuration details returned include workspace configuration status, label set limits, and retention period.

Examples:

Request syntax with placeholder values


resp = client.describe_workspace_configuration({
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.workspace_configuration.status.status_code #=> String, one of "ACTIVE", "UPDATING", "UPDATE_FAILED"
resp.workspace_configuration.status.status_reason #=> String
resp.workspace_configuration.limits_per_label_set #=> Array
resp.workspace_configuration.limits_per_label_set[0].limits.max_series #=> Integer
resp.workspace_configuration.limits_per_label_set[0].label_set #=> Hash
resp.workspace_configuration.limits_per_label_set[0].label_set["LabelName"] #=> String
resp.workspace_configuration.retention_period_in_days #=> Integer
resp.workspace_configuration.out_of_order_time_window_in_seconds #=> Integer
resp.workspace_configuration.rule_query_offset_in_seconds #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace that you want to retrieve information for. To find the IDs of your workspaces, use the ListWorkspaces operation.

Returns:

See Also:



1896
1897
1898
1899
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1896

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

#get_default_scraper_configuration(params = {}) ⇒ Types::GetDefaultScraperConfigurationResponse

The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.

Examples:

Example: GetDefaultScraperConfiguration


resp = client.get_default_scraper_configuration({
})

resp.to_h outputs the following:
{
  configuration: "blob", 
}

Response structure


resp.configuration #=> String

Parameters:

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

    ({})

Returns:

See Also:



1927
1928
1929
1930
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1927

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

#list_anomaly_detectors(params = {}) ⇒ Types::ListAnomalyDetectorsResponse

Returns a paginated list of anomaly detectors for a workspace with optional filtering by alias.

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_anomaly_detectors({
  workspace_id: "WorkspaceId", # required
  alias: "AnomalyDetectorAlias",
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.anomaly_detectors #=> Array
resp.anomaly_detectors[0].arn #=> String
resp.anomaly_detectors[0].anomaly_detector_id #=> String
resp.anomaly_detectors[0].alias #=> String
resp.anomaly_detectors[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
resp.anomaly_detectors[0].status.status_reason #=> String
resp.anomaly_detectors[0].created_at #=> Time
resp.anomaly_detectors[0].modified_at #=> Time
resp.anomaly_detectors[0].tags #=> Hash
resp.anomaly_detectors[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The identifier of the workspace containing the anomaly detectors to list.

  • :alias (String) —

    Filters the results to anomaly detectors with the specified alias.

  • :max_results (Integer) —

    The maximum number of results to return in a single call. Valid range is 1 to 1000.

  • :next_token (String) —

    The pagination token to continue retrieving results.

Returns:

See Also:



1983
1984
1985
1986
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1983

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

#list_rule_groups_namespaces(params = {}) ⇒ Types::ListRuleGroupsNamespacesResponse

Returns a list of rule groups namespaces in a workspace.

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_rule_groups_namespaces({
  workspace_id: "WorkspaceId", # required
  name: "RuleGroupsNamespaceName",
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.rule_groups_namespaces #=> Array
resp.rule_groups_namespaces[0].arn #=> String
resp.rule_groups_namespaces[0].name #=> String
resp.rule_groups_namespaces[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
resp.rule_groups_namespaces[0].status.status_reason #=> String
resp.rule_groups_namespaces[0].created_at #=> Time
resp.rule_groups_namespaces[0].modified_at #=> Time
resp.rule_groups_namespaces[0].tags #=> Hash
resp.rule_groups_namespaces[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace containing the rule groups namespaces.

  • :name (String) —

    Use this parameter to filter the rule groups namespaces that are returned. Only the namespaces with names that begin with the value that you specify are returned.

  • :next_token (String) —

    The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.

    For example, if your initial request has maxResults of 10, and there are 12 rule groups namespaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 namespaces.

  • :max_results (Integer) —

    The maximum number of results to return. The default is 100.

Returns:

See Also:



2044
2045
2046
2047
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 2044

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

#list_scrapers(params = {}) ⇒ Types::ListScrapersResponse

The ListScrapers operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: ListScrapers, with a max result of 2, using a pagination token from a previous call to ListScrapers


resp = client.list_scrapers({
  max_results: 2, 
  next_token: "previouslyGeneratedToken", 
})

resp.to_h outputs the following:
{
  scrapers: [
    {
      alias: "alias1", 
      arn: "arn:aws:aps:us-west-2:123456789012:scraper/scraper-123", 
      created_at: Time.parse("2023-01-01T00:00:00Z"), 
      destination: {
        amp_configuration: {
          workspace_arn: "arn:aws:aps:us-west-2:123456789012:workspace/ws-ogh2u499-ce12-hg89-v6c7-123412341234", 
        }, 
      }, 
      last_modified_at: Time.parse("2020-01-02T00:00:00Z"), 
      role_arn: "arn:aws:iam::123456789012:role/exampleRole", 
      scraper_id: "scraper-123", 
      source: {
        eks_configuration: {
          cluster_arn: "arn:aws:eks:us-west-2:123456789012:cluster/example1", 
          security_group_ids: [
            "sg-abc123", 
          ], 
          subnet_ids: [
            "subnet-abc123", 
          ], 
        }, 
      }, 
      status: {
        status_code: "ACTIVE", 
      }, 
      tags: {
        "exampleTag" => "exampleValue", 
      }, 
    }, 
    {
      alias: "alias2", 
      arn: "arn:aws:aps:us-west-2:123456789012:scraper/scraper-456", 
      created_at: Time.parse("2023-01-01T00:00:00Z"), 
      destination: {
        amp_configuration: {
          workspace_arn: "arn:aws:aps:us-west-2:123456789012:workspace/ws-ogh2u499-ce12-hg89-v6c7-123412341234", 
        }, 
      }, 
      last_modified_at: Time.parse("2020-01-02T00:00:00Z"), 
      role_arn: "arn:aws:iam::123456789012:role/exampleRole", 
      scraper_id: "scraper-456", 
      source: {
        eks_configuration: {
          cluster_arn: "arn:aws:eks:us-west-2:123456789012:cluster/example2", 
          security_group_ids: [
            "sg-abc456", 
          ], 
          subnet_ids: [
            "subnet-abc456", 
          ], 
        }, 
      }, 
      status: {
        status_code: "CREATING", 
      }, 
      tags: {
        "exampleTag" => "exampleValue", 
      }, 
    }, 
  ], 
}

Example: ListScrapers, with filters


resp = client.list_scrapers({
  filters: {
    "alias" => [
      "alias1", 
    ], 
    "sourceArn" => [
      "arn:aws:eks:us-west-2:123456789012:cluster/example1", 
    ], 
    "status" => [
      "ACTIVE", 
    ], 
  }, 
})

resp.to_h outputs the following:
{
  scrapers: [
    {
      alias: "alias1", 
      arn: "arn:aws:aps:us-west-2:123456789012:scraper/scraper-123", 
      created_at: Time.parse("2023-01-01T00:00:00Z"), 
      destination: {
        amp_configuration: {
          workspace_arn: "arn:aws:aps:us-west-2:123456789012:workspace/ws-ogh2u499-ce12-hg89-v6c7-123412341234", 
        }, 
      }, 
      last_modified_at: Time.parse("2020-01-02T00:00:00Z"), 
      role_arn: "arn:aws:iam::123456789012:role/exampleRole", 
      scraper_id: "scraper-123", 
      source: {
        eks_configuration: {
          cluster_arn: "arn:aws:eks:us-west-2:123456789012:cluster/example1", 
          security_group_ids: [
            "sg-abc123", 
          ], 
          subnet_ids: [
            "subnet-abc123", 
          ], 
        }, 
      }, 
      status: {
        status_code: "ACTIVE", 
      }, 
      tags: {
        "exampleTag" => "exampleValue", 
      }, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_scrapers({
  filters: {
    "FilterKey" => ["FilterValue"],
  },
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.scrapers #=> Array
resp.scrapers[0].alias #=> String
resp.scrapers[0].scraper_id #=> String
resp.scrapers[0].arn #=> String
resp.scrapers[0].role_arn #=> String
resp.scrapers[0].status.status_code #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
resp.scrapers[0].created_at #=> Time
resp.scrapers[0].last_modified_at #=> Time
resp.scrapers[0].tags #=> Hash
resp.scrapers[0].tags["TagKey"] #=> String
resp.scrapers[0].status_reason #=> String
resp.scrapers[0].source.eks_configuration.cluster_arn #=> String
resp.scrapers[0].source.eks_configuration.security_group_ids #=> Array
resp.scrapers[0].source.eks_configuration.security_group_ids[0] #=> String
resp.scrapers[0].source.eks_configuration.subnet_ids #=> Array
resp.scrapers[0].source.eks_configuration.subnet_ids[0] #=> String
resp.scrapers[0].source.vpc_configuration.security_group_ids #=> Array
resp.scrapers[0].source.vpc_configuration.security_group_ids[0] #=> String
resp.scrapers[0].source.vpc_configuration.subnet_ids #=> Array
resp.scrapers[0].source.vpc_configuration.subnet_ids[0] #=> String
resp.scrapers[0].destination.amp_configuration.workspace_arn #=> String
resp.scrapers[0].destination.cloud_watch_configuration.dataset_arn #=> String
resp.scrapers[0].role_configuration.source_role_arn #=> String
resp.scrapers[0].role_configuration.target_role_arn #=> String
resp.scrapers[0].exporters #=> Array
resp.scrapers[0].exporters[0].open_search_configuration.domain_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Hash<String,Array>) — default: Optional —

    A list of key-value pairs to filter the list of scrapers returned. Keys include status, sourceArn, destinationArn, and alias.

    Filters on the same key are OR'd together, and filters on different keys are AND'd together. For example, status=ACTIVE&status=CREATING&alias=Test, will return all scrapers that have the alias Test, and are either in status ACTIVE or CREATING.

    To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus workspace, you would use the ARN of the workspace in a query:

    status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012

    If this is included, it filters the results to only the scrapers that match the filter.

  • :next_token (String) — default: Optional —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :max_results (Integer) —

    Optional) The maximum number of scrapers to return in one ListScrapers operation. The range is 1-1000.

    If you omit this parameter, the default of 100 is used.

Returns:

See Also:



2259
2260
2261
2262
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 2259

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

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

The ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be tagged are scrapers, workspaces, and rule groups namespaces.

Examples:

Request syntax with placeholder values


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

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to list tages for. Must be a workspace, scraper, or rule groups namespace resource.

Returns:

See Also:



2292
2293
2294
2295
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 2292

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

#list_workspaces(params = {}) ⇒ Types::ListWorkspacesResponse

Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.

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_workspaces({
  next_token: "PaginationToken",
  alias: "WorkspaceAlias",
  max_results: 1,
})

Response structure


resp.workspaces #=> Array
resp.workspaces[0].workspace_id #=> String
resp.workspaces[0].alias #=> String
resp.workspaces[0].arn #=> String
resp.workspaces[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED"
resp.workspaces[0].created_at #=> Time
resp.workspaces[0].tags #=> Hash
resp.workspaces[0].tags["TagKey"] #=> String
resp.workspaces[0].kms_key_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.

    For example, if your initial request has maxResults of 10, and there are 12 workspaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 workspaces.

  • :alias (String) —

    If this is included, it filters the results to only the workspaces with names that start with the value that you specify here.

    Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.

  • :max_results (Integer) —

    The maximum number of workspaces to return per request. The default is 100.

Returns:

See Also:



2353
2354
2355
2356
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 2353

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

#put_alert_manager_definition(params = {}) ⇒ Types::PutAlertManagerDefinitionResponse

Updates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to create it. Instead, use CreateAlertManagerDefinition.

Examples:

Request syntax with placeholder values


resp = client.put_alert_manager_definition({
  workspace_id: "WorkspaceId", # required
  data: "data", # required
  client_token: "IdempotencyToken",
})

Response structure


resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
resp.status.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to update the alert manager definition in.

  • :data (required, String, StringIO, File) —

    The alert manager definition to use. A base64-encoded version of the YAML alert manager definition file.

    For details about the alert manager definition, see AlertManagedDefinitionData.

  • :client_token (String) —

    A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



2405
2406
2407
2408
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 2405

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

#put_anomaly_detector(params = {}) ⇒ Types::PutAnomalyDetectorResponse

When you call PutAnomalyDetector, the operation creates a new anomaly detector if one doesn't exist, or updates an existing one. Each call to this operation triggers a complete retraining of the detector, which includes querying the minimum required samples and backfilling the detector with historical data. This process occurs regardless of whether you're making a minor change like updating the evaluation interval or making more substantial modifications. The operation serves as the single method for creating, updating, and retraining anomaly detectors.

Examples:

Request syntax with placeholder values


resp = client.put_anomaly_detector({
  workspace_id: "WorkspaceId", # required
  anomaly_detector_id: "AnomalyDetectorId", # required
  evaluation_interval_in_seconds: 1,
  missing_data_action: {
    mark_as_anomaly: false,
    skip: false,
  },
  configuration: { # required
    random_cut_forest: {
      query: "RandomCutForestQuery", # required
      shingle_size: 1,
      sample_size: 1,
      ignore_near_expected_from_above: {
        amount: 1.0,
        ratio: 1.0,
      },
      ignore_near_expected_from_below: {
        amount: 1.0,
        ratio: 1.0,
      },
    },
  },
  labels: {
    "PrometheusMetricLabelKey" => "PrometheusMetricLabelValue",
  },
  client_token: "IdempotencyToken",
})

Response structure


resp.anomaly_detector_id #=> String
resp.arn #=> String
resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
resp.status.status_reason #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The identifier of the workspace containing the anomaly detector to update.

  • :anomaly_detector_id (required, String) —

    The identifier of the anomaly detector to update.

  • :evaluation_interval_in_seconds (Integer) —

    The frequency, in seconds, at which the anomaly detector evaluates metrics.

  • :missing_data_action (Types::AnomalyDetectorMissingDataAction) —

    Specifies the action to take when data is missing during evaluation.

  • :configuration (required, Types::AnomalyDetectorConfiguration) —

    The algorithm configuration for the anomaly detector.

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

    The Amazon Managed Service for Prometheus metric labels to associate with the anomaly detector.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



2499
2500
2501
2502
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 2499

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

#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse

Creates or updates a resource-based policy for an Amazon Managed Service for Prometheus workspace. Use resource-based policies to grant permissions to other AWS accounts or services to access your workspace.

Only Prometheus-compatible APIs can be used for workspace sharing. You can add non-Prometheus-compatible APIs to the policy, but they will be ignored. For more information, see Prometheus-compatible APIs in the Amazon Managed Service for Prometheus User Guide.

If your workspace uses customer-managed KMS keys for encryption, you must grant the principals in your resource-based policy access to those KMS keys. You can do this by creating KMS grants. For more information, see CreateGrant in the AWS Key Management Service API Reference and Encryption at rest in the Amazon Managed Service for Prometheus User Guide.

For more information about working with IAM, see Using Amazon Managed Service for Prometheus with IAM in the Amazon Managed Service for Prometheus User Guide.

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  workspace_id: "WorkspaceId", # required
  policy_document: "String", # required
  client_token: "IdempotencyToken",
  revision_id: "String",
})

Response structure


resp.policy_status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING"
resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to attach the resource-based policy to.

  • :policy_document (required, String) —

    The JSON policy document to use as the resource-based policy. This policy defines the permissions that other AWS accounts or services have to access your workspace.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the request is safe to retry (idempotent).

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :revision_id (String) —

    The revision ID of the policy to update. Use this parameter to ensure that you are updating the correct version of the policy. If you don't specify a revision ID, the policy is updated regardless of its current revision.

    For the first PUT request on a workspace that doesn't have an existing resource policy, you can specify NO_POLICY as the revision ID.

Returns:

See Also:



2580
2581
2582
2583
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 2580

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

#put_rule_groups_namespace(params = {}) ⇒ Types::PutRuleGroupsNamespaceResponse

Updates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.

The combined length of a rule group namespace and a rule group name cannot exceed 721 UTF-8 bytes.

Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use CreateRuleGroupsNamespace.

You can't use this operation to add tags to an existing rule groups namespace. Instead, use TagResource.

Examples:

Request syntax with placeholder values


resp = client.put_rule_groups_namespace({
  workspace_id: "WorkspaceId", # required
  name: "RuleGroupsNamespaceName", # required
  data: "data", # required
  client_token: "IdempotencyToken",
})

Response structure


resp.name #=> String
resp.arn #=> String
resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
resp.status.status_reason #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace where you are updating the rule groups namespace.

  • :name (required, String) —

    The name of the rule groups namespace that you are updating.

  • :data (required, String, StringIO, File) —

    The new rules file to use in the namespace. A base64-encoded version of the YAML rule groups file.

    For details about the rule groups namespace structure, see RuleGroupsNamespaceData.

  • :client_token (String) —

    A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



2652
2653
2654
2655
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 2652

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

#tag_resource(params = {}) ⇒ Struct

The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups namespaces, scrapers, and workspaces.

If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. To remove a tag, use UntagResource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to apply tags to.

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

    The list of tag keys and values to associate with the resource.

    Keys must not begin with aws:.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2690
2691
2692
2693
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 2690

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

#untag_resource(params = {}) ⇒ Struct

Removes the specified tags from an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups namespaces, scrapers, and workspaces.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource from which to remove a tag.

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

    The keys of the tags to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2718
2719
2720
2721
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 2718

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

#update_logging_configuration(params = {}) ⇒ Types::UpdateLoggingConfigurationResponse

Updates the log group ARN or the workspace ID of the current rules and alerting logging configuration.

These logging configurations are only for rules and alerting logs.

Examples:

Request syntax with placeholder values


resp = client.update_logging_configuration({
  workspace_id: "WorkspaceId", # required
  log_group_arn: "LogGroupArn", # required
  client_token: "IdempotencyToken",
})

Response structure


resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
resp.status.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to update the logging configuration for.

  • :log_group_arn (required, String) —

    The ARN of the CloudWatch log group to which the vended log data will be published.

  • :client_token (String) —

    A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



2765
2766
2767
2768
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 2765

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

#update_query_logging_configuration(params = {}) ⇒ Types::UpdateQueryLoggingConfigurationResponse

Updates the query logging configuration for the specified workspace.

Examples:

Request syntax with placeholder values


resp = client.update_query_logging_configuration({
  workspace_id: "WorkspaceId", # required
  destinations: [ # required
    {
      cloud_watch_logs: { # required
        log_group_arn: "LogGroupArn", # required
      },
      filters: { # required
        qsp_threshold: 1, # required
      },
    },
  ],
  client_token: "IdempotencyToken",
})

Response structure


resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
resp.status.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace for which to update the query logging configuration.

  • :destinations (required, Array<Types::LoggingDestination>) —

    The destinations where query logs will be sent. Only CloudWatch Logs destination is supported. The list must contain exactly one element.

  • :client_token (String) — default: Optional —

    A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



2817
2818
2819
2820
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 2817

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

#update_scraper(params = {}) ⇒ Types::UpdateScraperResponse

Updates an existing scraper.

You can't use this function to update the source from which the scraper is collecting metrics. To change the source, delete the scraper and create a new one.

Examples:

Example: UpdateScraper with all optional parameters


resp = client.update_scraper({
  alias: "alias-update", 
  client_token: "token", 
  destination: {
    amp_configuration: {
      workspace_arn: "arn:aws:aps:us-west-2:123456789012:workspace/ws-ogh2u499-ce12-hg89-v6c7-123412341234-update", 
    }, 
  }, 
  scrape_configuration: {
    configuration_blob: "blob-update", 
  }, 
  scraper_id: "scraper-123", 
})

resp.to_h outputs the following:
{
  arn: "arn:aws:aps:us-west-2:123456789012:scraper/scraper-123", 
  scraper_id: "scraper-123", 
  status: {
    status_code: "UPDATING", 
  }, 
  tags: {
    "exampleTag" => "exampleValue", 
  }, 
}

Request syntax with placeholder values


resp = client.update_scraper({
  scraper_id: "ScraperId", # required
  alias: "ScraperAlias",
  scrape_configuration: {
    configuration_blob: "data",
  },
  destination: {
    amp_configuration: {
      workspace_arn: "WorkspaceArn", # required
    },
    cloud_watch_configuration: {
      dataset_arn: "CloudWatchDatasetArn", # required
    },
  },
  role_configuration: {
    source_role_arn: "IamRoleArn",
    target_role_arn: "IamRoleArn",
  },
  client_token: "IdempotencyToken",
  exporters: [
    {
      open_search_configuration: {
        domain_arn: "OpenSearchDomainArn", # required
      },
    },
  ],
})

Response structure


resp.scraper_id #=> String
resp.arn #=> String
resp.status.status_code #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :scraper_id (required, String) —

    The ID of the scraper to update.

  • :alias (String) —

    The new alias of the scraper.

  • :scrape_configuration (Types::ScrapeConfiguration) —

    Contains the base-64 encoded YAML configuration for the scraper.

    For more information about configuring a scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide.

  • :destination (Types::Destination) —

    The new destination where the scraper sends metrics. Valid destinations are Amazon Managed Service for Prometheus workspaces and CloudWatch datasets.

  • :role_configuration (Types::RoleConfiguration) —

    Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.

  • :client_token (String) —

    A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :exporters (Array<Types::ExporterConfiguration>) —

    The exporter configurations for the scraper. You can configure at most one Amazon OpenSearch Service domain. If you don't specify a value, the existing exporter configuration remains unchanged.

Returns:

See Also:



2946
2947
2948
2949
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 2946

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

#update_scraper_logging_configuration(params = {}) ⇒ Types::UpdateScraperLoggingConfigurationResponse

Updates the logging configuration for a Amazon Managed Service for Prometheus scraper.

Examples:

Request syntax with placeholder values


resp = client.update_scraper_logging_configuration({
  scraper_id: "ScraperId", # required
  logging_destination: { # required
    cloud_watch_logs: {
      log_group_arn: "LogGroupArn", # required
    },
  },
  scraper_components: [
    {
      type: "SERVICE_DISCOVERY", # required, accepts SERVICE_DISCOVERY, COLLECTOR, EXPORTER
      config: {
        options: {
          "String" => "String",
        },
      },
    },
  ],
})

Response structure


resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
resp.status.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :scraper_id (required, String) —

    The ID of the scraper whose logging configuration will be updated.

  • :logging_destination (required, Types::ScraperLoggingDestination) —

    The destination where scraper logs will be sent.

  • :scraper_components (Array<Types::ScraperComponent>) —

    The list of scraper components to configure for logging.

Returns:

See Also:



2997
2998
2999
3000
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 2997

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

#update_workspace_alias(params = {}) ⇒ Struct

Updates the alias of an existing workspace.

Examples:

Request syntax with placeholder values


resp = client.update_workspace_alias({
  workspace_id: "WorkspaceId", # required
  alias: "WorkspaceAlias",
  client_token: "IdempotencyToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to update.

  • :alias (String) —

    The new alias for the workspace. It does not need to be unique.

    Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.

  • :client_token (String) —

    A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3034
3035
3036
3037
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 3034

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

#update_workspace_configuration(params = {}) ⇒ Types::UpdateWorkspaceConfigurationResponse

Use this operation to create or update the label sets, label set limits, and retention period of a workspace.

You must specify at least one of limitsPerLabelSet or retentionPeriodInDays for the request to be valid.

Examples:

Request syntax with placeholder values


resp = client.update_workspace_configuration({
  workspace_id: "WorkspaceId", # required
  client_token: "IdempotencyToken",
  limits_per_label_set: [
    {
      limits: { # required
        max_series: 1,
      },
      label_set: { # required
        "LabelName" => "LabelValue",
      },
    },
  ],
  retention_period_in_days: 1,
  out_of_order_time_window_in_seconds: 1,
  rule_query_offset_in_seconds: 1,
})

Response structure


resp.status.status_code #=> String, one of "ACTIVE", "UPDATING", "UPDATE_FAILED"
resp.status.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace that you want to update. To find the IDs of your workspaces, use the ListWorkspaces operation.

  • :client_token (String) —

    You can include a token in your operation to make it an idempotent opeartion.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :limits_per_label_set (Array<Types::LimitsPerLabelSet>) —

    This is an array of structures, where each structure defines a label set for the workspace, and defines the active time series limit for each of those label sets. Each label name in a label set must be unique.

  • :retention_period_in_days (Integer) —

    Specifies how many days that metrics will be retained in the workspace.

  • :out_of_order_time_window_in_seconds (Integer) —

    Specifies the time window in seconds for accepting out of order samples. Out of order samples older than this window are rejected.

  • :rule_query_offset_in_seconds (Integer) —

    Specifies the duration in seconds to offset rule evaluation queries into the past. This allows ingested samples to be available before rule evaluation.

Returns:

See Also:



3112
3113
3114
3115
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 3112

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

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
anomaly_detector_active #describe_anomaly_detector 2 60
anomaly_detector_deleted #describe_anomaly_detector 2 60
scraper_active #describe_scraper 2 60
scraper_deleted #describe_scraper 2 60
workspace_active #describe_workspace 2 60
workspace_deleted #describe_workspace 2 60

Parameters:

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

    ({})

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

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



3232
3233
3234
3235
3236
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 3232

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end