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

  • :credentials (required, Aws::CredentialProvider)

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

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

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

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

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

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

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

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

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

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

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.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::InstanceProfileCredentails 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)
  • :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.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

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

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

  • :retry_backoff (Proc)

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

  • :retry_base_delay (Float) — default: 0.3

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

  • :retry_jitter (Symbol) — default: :none

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

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

  • :retry_limit (Integer) — default: 3

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

  • :retry_max_delay (Integer) — default: 0

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

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

    Specifies which retry algorithm to use. Values are:

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

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

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

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

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

  • :http_proxy (URI::HTTP, String)

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

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

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

  • :ssl_timeout (Float) — default: nil

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false

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

  • :ssl_verify_peer (Boolean) — default: true

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

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



348
349
350
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 348

def initialize(*args)
  super
end

Instance Method Details

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

Create an alert manager definition.

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)

    Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

    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 data.

  • :workspace_id (required, String)

    The ID of the workspace in which to create the alert manager definition.

Returns:

See Also:



391
392
393
394
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 391

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

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

Create a rule group namespace.

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)

    Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

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

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

    The namespace data that define the rule groups.

  • :name (required, String)

    The rule groups namespace name.

  • :tags (Hash<String,String>)

    Optional, user-provided tags for this rule groups namespace.

  • :workspace_id (required, String)

    The ID of the workspace in which to create the rule group namespace.

Returns:

See Also:



449
450
451
452
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 449

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

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

Creates a new AMP workspace.

Examples:

Request syntax with placeholder values


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

Response structure


resp.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 optional user-assigned alias for this workspace. This alias is for user reference and does not need to be unique.

  • :client_token (String)

    Optional, unique, case-sensitive, user-provided identifier 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>)

    Optional, user-provided tags for this workspace.

Returns:

See Also:



499
500
501
502
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 499

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

#delete_alert_manager_definition(params = {}) ⇒ Struct

Deletes an alert manager definition.

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)

    Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

    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 in which to delete the alert manager definition.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



530
531
532
533
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 530

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

#delete_rule_groups_namespace(params = {}) ⇒ Struct

Delete a rule groups namespace.

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)

    Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

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

  • :name (required, String)

    The rule groups namespace name.

  • :workspace_id (required, String)

    The ID of the workspace to delete rule group definition.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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

#delete_workspace(params = {}) ⇒ Struct

Deletes an AMP workspace.

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)

    Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

    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:



594
595
596
597
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 594

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

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

Describes an alert manager definition.

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 describe.

Returns:

See Also:



626
627
628
629
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 626

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

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

Describe a rule groups namespace.

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 rule groups namespace.

  • :workspace_id (required, String)

    The ID of the workspace to describe.

Returns:

See Also:



666
667
668
669
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 666

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

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

Describes an existing AMP 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.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:



707
708
709
710
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 707

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

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

Lists rule groups namespaces.

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)

    Maximum results to return in response (default=100, maximum=1000).

  • :name (String)

    Optional filter for rule groups namespace name. Only the rule groups namespace that begin with this value will be returned.

  • :next_token (String)

    Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListRuleGroupsNamespaces request.

  • :workspace_id (required, String)

    The ID of the workspace.

Returns:

See Also:



762
763
764
765
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 762

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

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

Lists the tags you have assigned to the resource.

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.

Returns:

See Also:



791
792
793
794
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 791

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 AMP workspaces, including 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].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)

    Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.

  • :max_results (Integer)

    Maximum results to return in response (default=100, maximum=1000).

  • :next_token (String)

    Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.

Returns:

See Also:



842
843
844
845
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 842

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

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

Update an alert manager definition.

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)

    Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

    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 data.

  • :workspace_id (required, String)

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

Returns:

See Also:



884
885
886
887
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 884

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

Update a rule groups namespace.

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)

    Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

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

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

    The namespace data that define the rule groups.

  • :name (required, String)

    The rule groups namespace name.

  • :workspace_id (required, String)

    The ID of the workspace in which to update the rule group namespace.

Returns:

See Also:



936
937
938
939
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 936

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

#tag_resource(params = {}) ⇒ Struct

Creates tags for the specified resource.

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.

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

    The list of tags assigned to the resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



964
965
966
967
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 964

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

#untag_resource(params = {}) ⇒ Struct

Deletes tags from the specified resource.

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.

  • :tag_keys (required, Array<String>)

    One or more tag keys

Returns:

  • (Struct)

    Returns an empty response.

See Also:



990
991
992
993
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 990

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

#update_workspace_alias(params = {}) ⇒ Struct

Updates an AMP workspace alias.

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 of the workspace.

  • :client_token (String)

    Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

    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 being updated.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1024
1025
1026
1027
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1024

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



1135
1136
1137
1138
1139
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb', line 1135

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