Class: Aws::PrometheusService::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and ENV

    • ‘~/.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 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:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

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

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

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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

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

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

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

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

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

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

  • :ignore_configured_endpoint_urls (Boolean) —

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

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

    The log formatter.

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

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

  • :request_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 www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

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

  • :retry_max_delay (Integer) — default: 0 —

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

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

    Specifies which retry algorithm to use. Values are:

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

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

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

  • :sdk_ua_app_id (String) —

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

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

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

  • :stub_responses (Boolean) — default: false —

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

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

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

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

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

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

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

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

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

  • :use_dualstack_endpoint (Boolean) —

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

  • :use_fips_endpoint (Boolean) —

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

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::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 ‘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.



467
468
469
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 467

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2073
2074
2075
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 2073

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2076
2077
2078
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 2076

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1927

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::PrometheusService')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-prometheusservice'
  context[:gem_version] = '1.50.0'
  Seahorse::Client::Request.new(handlers, context)
end

#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({
  client_token: "IdempotencyToken",
  data: "data", # required
  workspace_id: "WorkspaceId", # required
})

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

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

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

    [1]: docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html

  • :workspace_id (required, String) —

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

Returns:

See Also:



520
521
522
523
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 520

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

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

The ‘CreateLoggingConfiguration` operation creates a logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.

Examples:

Request syntax with placeholder values


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

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

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

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

  • :workspace_id (required, String) —

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

Returns:

See Also:



565
566
567
568
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 565

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

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({
  client_token: "IdempotencyToken",
  data: "data", # required
  name: "RuleGroupsNamespaceName", # required
  tags: {
    "TagKey" => "TagValue",
  },
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.arn #=> String
resp.name #=> 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):

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

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

    [1]: docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html

  • :name (required, String) —

    The name for the new rule groups namespace.

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

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

  • :workspace_id (required, String) —

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

Returns:

See Also:



640
641
642
643
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 640

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

The ‘CreateScraper` operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. Scrapers are flexible, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applied 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 cluster. You must configure this role with a policy that allows it to scrape metrics from your cluster. For more information, 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.

<note markdown=“1”> 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*.

</note>

[1]: docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-eks-setup [2]: docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.scraper_id #=> 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.

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

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

    The Amazon Managed Service for Prometheus workspace to send metrics to.

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

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

    [1]: docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration

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

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

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

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

Returns:

See Also:



757
758
759
760
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 757

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",
  kms_key_arn: "KmsKeyArn",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.kms_key_arn #=> String
resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.workspace_id #=> 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.**

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

    [1]: docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html

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

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

Returns:

See Also:



825
826
827
828
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 825

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({
  client_token: "IdempotencyToken",
  workspace_id: "WorkspaceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

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

  • :workspace_id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



855
856
857
858
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 855

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

#delete_logging_configuration(params = {}) ⇒ Struct

Deletes the logging configuration for a workspace.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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

  • :workspace_id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



886
887
888
889
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 886

def delete_logging_configuration(params = {}, options = {})
  req = build_request(:delete_logging_configuration, 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({
  client_token: "IdempotencyToken",
  name: "RuleGroupsNamespaceName", # required
  workspace_id: "WorkspaceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

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

  • :name (required, String) —

    The name of the rule groups namespace to delete.

  • :workspace_id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



922
923
924
925
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 922

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:

Request syntax with placeholder values


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

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

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

  • :scraper_id (required, String) —

    The ID of the scraper to delete.

Returns:

See Also:



961
962
963
964
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 961

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

#delete_workspace(params = {}) ⇒ Struct

Deletes an existing workspace.

<note markdown=“1”> 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.

</note>

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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

  • :workspace_id (required, String) —

    The ID of the workspace to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



997
998
999
1000
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 997

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.created_at #=> Time
resp.alert_manager_definition.data #=> String
resp.alert_manager_definition.modified_at #=> Time
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

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:



1030
1031
1032
1033
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1030

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

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

Returns complete information about the current logging configuration of the workspace.

Examples:

Request syntax with placeholder values


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

Response structure


resp.logging_configuration.created_at #=> Time
resp.logging_configuration.log_group_arn #=> String
resp.logging_configuration.modified_at #=> Time
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

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:



1064
1065
1066
1067
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1064

def describe_logging_configuration(params = {}, options = {})
  req = build_request(:describe_logging_configuration, 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({
  name: "RuleGroupsNamespaceName", # required
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.rule_groups_namespace.arn #=> String
resp.rule_groups_namespace.created_at #=> Time
resp.rule_groups_namespace.data #=> String
resp.rule_groups_namespace.modified_at #=> Time
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.tags #=> Hash
resp.rule_groups_namespace.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :workspace_id (required, String) —

    The ID of the workspace containing the rule groups namespace.

Returns:

See Also:



1106
1107
1108
1109
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1106

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:

Request syntax with placeholder values


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

Response structure


resp.scraper.alias #=> String
resp.scraper.arn #=> String
resp.scraper.created_at #=> Time
resp.scraper.destination.amp_configuration.workspace_arn #=> String
resp.scraper.last_modified_at #=> Time
resp.scraper.role_arn #=> String
resp.scraper.role_configuration.source_role_arn #=> String
resp.scraper.role_configuration.target_role_arn #=> String
resp.scraper.scrape_configuration.configuration_blob #=> String
resp.scraper.scraper_id #=> 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.status.status_code #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
resp.scraper.status_reason #=> String
resp.scraper.tags #=> Hash
resp.scraper.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :scraper_id (required, String) —

    The ID of the scraper to describe.

Returns:

See Also:



1159
1160
1161
1162
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1159

def describe_scraper(params = {}, options = {})
  req = build_request(:describe_scraper, 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.alias #=> String
resp.workspace.arn #=> String
resp.workspace.created_at #=> Time
resp.workspace.kms_key_arn #=> String
resp.workspace.prometheus_endpoint #=> String
resp.workspace.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED"
resp.workspace.tags #=> Hash
resp.workspace.tags["TagKey"] #=> String
resp.workspace.workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to describe.

Returns:

See Also:



1201
1202
1203
1204
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1201

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.limits_per_label_set #=> Array
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.limits_per_label_set[0].limits.max_series #=> Integer
resp.workspace_configuration.retention_period_in_days #=> Integer
resp.workspace_configuration.status.status_code #=> String, one of "ACTIVE", "UPDATING", "UPDATE_FAILED"
resp.workspace_configuration.status.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1243
1244
1245
1246
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1243

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:

Response structure


resp.configuration #=> String

Parameters:

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

    ({})

Returns:

See Also:



1263
1264
1265
1266
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1263

def get_default_scraper_configuration(params = {}, options = {})
  req = build_request(:get_default_scraper_configuration, 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({
  max_results: 1,
  name: "RuleGroupsNamespaceName",
  next_token: "PaginationToken",
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.next_token #=> String
resp.rule_groups_namespaces #=> Array
resp.rule_groups_namespaces[0].arn #=> String
resp.rule_groups_namespaces[0].created_at #=> Time
resp.rule_groups_namespaces[0].modified_at #=> Time
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].tags #=> Hash
resp.rule_groups_namespaces[0].tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

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

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

  • :workspace_id (required, String) —

    The ID of the workspace containing the rule groups namespaces.

Returns:

See Also:



1324
1325
1326
1327
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1324

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:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.scrapers #=> Array
resp.scrapers[0].alias #=> String
resp.scrapers[0].arn #=> String
resp.scrapers[0].created_at #=> Time
resp.scrapers[0].destination.amp_configuration.workspace_arn #=> String
resp.scrapers[0].last_modified_at #=> Time
resp.scrapers[0].role_arn #=> String
resp.scrapers[0].role_configuration.source_role_arn #=> String
resp.scrapers[0].role_configuration.target_role_arn #=> String
resp.scrapers[0].scraper_id #=> 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].status.status_code #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
resp.scrapers[0].status_reason #=> String
resp.scrapers[0].tags #=> Hash
resp.scrapers[0].tags["TagKey"] #=> 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.

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

  • :next_token (String) — default: Optional —

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

Returns:

See Also:



1406
1407
1408
1409
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1406

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:



1439
1440
1441
1442
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1439

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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

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

Returns:

See Also:



1500
1501
1502
1503
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1500

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({
  client_token: "IdempotencyToken",
  data: "data", # required
  workspace_id: "WorkspaceId", # required
})

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

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

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

    [1]: docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html

  • :workspace_id (required, String) —

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

Returns:

See Also:



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

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

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({
  client_token: "IdempotencyToken",
  data: "data", # required
  name: "RuleGroupsNamespaceName", # required
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.arn #=> String
resp.name #=> 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):

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

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

    [1]: docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html

  • :name (required, String) —

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

  • :workspace_id (required, String) —

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

Returns:

See Also:



1621
1622
1623
1624
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1621

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:



1659
1660
1661
1662
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1659

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:



1687
1688
1689
1690
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1687

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 logging configuration.

Examples:

Request syntax with placeholder values


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

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

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

  • :log_group_arn (required, String) —

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

  • :workspace_id (required, String) —

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

Returns:

See Also:



1730
1731
1732
1733
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1730

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

Request syntax with placeholder values


resp = client.update_scraper({
  alias: "ScraperAlias",
  client_token: "IdempotencyToken",
  destination: {
    amp_configuration: {
      workspace_arn: "WorkspaceArn", # required
    },
  },
  role_configuration: {
    source_role_arn: "IamRoleArn",
    target_role_arn: "IamRoleArn",
  },
  scrape_configuration: {
    configuration_blob: "data",
  },
  scraper_id: "ScraperId", # required
})

Response structure


resp.arn #=> String
resp.scraper_id #=> 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) —

    The new alias of the scraper.

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

  • :destination (Types::Destination) —

    The new Amazon Managed Service for Prometheus workspace to send metrics to.

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

  • :scrape_configuration (Types::ScrapeConfiguration) —

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

    <note markdown=“1”> For more information about configuring a scraper, see [Using an Amazon Web Services managed collector] in the *Amazon Managed Service for Prometheus User Guide*.

    </note>

    [1]: docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html

  • :scraper_id (required, String) —

    The ID of the scraper to update.

Returns:

See Also:



1814
1815
1816
1817
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1814

def update_scraper(params = {}, options = {})
  req = build_request(:update_scraper, 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({
  alias: "WorkspaceAlias",
  client_token: "IdempotencyToken",
  workspace_id: "WorkspaceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

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

  • :workspace_id (required, String) —

    The ID of the workspace to update.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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({
  client_token: "IdempotencyToken",
  limits_per_label_set: [
    {
      label_set: { # required
        "LabelName" => "LabelValue",
      },
      limits: { # required
        max_series: 1,
      },
    },
  ],
  retention_period_in_days: 1,
  workspace_id: "WorkspaceId", # required
})

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

  • :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 ingestion limit for active time series 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.

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

    [1]: docs.aws.amazon.com/prometheus/latest/APIReference/API_ListWorkspaces.htm

Returns:

See Also:



1918
1919
1920
1921
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 1918

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 | | —————– | ————————— | ——– | ————- | | 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.



2036
2037
2038
2039
2040
 
# File 'lib/aws-sdk-prometheusservice/client.rb', line 2036

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


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

def waiter_names
  waiters.keys
end