Class: Aws::PI::Client

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

Overview

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

client = Aws::PI::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

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

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

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

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

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

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

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

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

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

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

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

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

    • Aws.config[:credentials]

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

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

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

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

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :auth_scheme_preference (Array<String>) —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

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

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

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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

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

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

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

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

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

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

  • :ignore_configured_endpoint_urls (Boolean) —

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

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

    The log formatter.

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

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

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

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

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

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

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

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

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

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

  • :retry_base_delay (Float) — default: 0.3 —

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

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

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

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

  • :retry_limit (Integer) — default: 3 —

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

  • :retry_max_delay (Integer) — default: 0 —

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

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

    Specifies which retry algorithm to use. Values are:

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

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

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

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

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

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

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

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

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

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

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

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

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

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

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

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

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

  • :use_dualstack_endpoint (Boolean) —

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

  • :use_fips_endpoint (Boolean) —

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

  • :validate_params (Boolean) — default: true —

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

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

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

  • :http_continue_timeout (Float) — default: 1 —

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_open_timeout (Float) — default: 15 —

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

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

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

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

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

  • :on_chunk_sent (Proc) —

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

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

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

  • :ssl_ca_directory (String) —

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

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

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



478
479
480
 
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 478

def initialize(*args)
  super
end

Instance Method Details

#create_performance_analysis_report(params = {}) ⇒ Types::CreatePerformanceAnalysisReportResponse

Creates a new performance analysis report for a specific time period for the DB instance.

Examples:

Request syntax with placeholder values


resp = client.create_performance_analysis_report({
  service_type: "RDS", # required, accepts RDS, DOCDB
  identifier: "IdentifierString", # required
  start_time: Time.now, # required
  end_time: Time.now, # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.analysis_report_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_type (required, String) —

    The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.

  • :identifier (required, String) —

    An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

    To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-ADECBTYHKTSAUMUZQYPDS2GW4A.

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

    The start time defined for the analysis report.

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

    The end time defined for the analysis report.

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

    The metadata assigned to the analysis report consisting of a key-value pair.

Returns:

See Also:



536
537
538
539
 
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 536

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

#delete_performance_analysis_report(params = {}) ⇒ Struct

Deletes a performance analysis report.

Examples:

Request syntax with placeholder values


resp = client.delete_performance_analysis_report({
  service_type: "RDS", # required, accepts RDS, DOCDB
  identifier: "IdentifierString", # required
  analysis_report_id: "AnalysisReportId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :service_type (required, String) —

    The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.

  • :identifier (required, String) —

    An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

    To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

  • :analysis_report_id (required, String) —

    The unique identifier of the analysis report for deletion.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



574
575
576
577
 
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 574

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

#describe_dimension_keys(params = {}) ⇒ Types::DescribeDimensionKeysResponse

For a specific time period, retrieve the top N dimension keys for a metric.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

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

Examples:

Request syntax with placeholder values


resp = client.describe_dimension_keys({
  service_type: "RDS", # required, accepts RDS, DOCDB
  identifier: "IdentifierString", # required
  start_time: Time.now, # required
  end_time: Time.now, # required
  metric: "RequestString", # required
  period_in_seconds: 1,
  group_by: { # required
    group: "SanitizedString", # required
    dimensions: ["SanitizedString"],
    limit: 1,
  },
  additional_metrics: ["SanitizedString"],
  partition_by: {
    group: "SanitizedString", # required
    dimensions: ["SanitizedString"],
    limit: 1,
  },
  filter: {
    "SanitizedString" => "RequestString",
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.aligned_start_time #=> Time
resp.aligned_end_time #=> Time
resp.partition_keys #=> Array
resp.partition_keys[0].dimensions #=> Hash
resp.partition_keys[0].dimensions["RequestString"] #=> String
resp.keys #=> Array
resp.keys[0].dimensions #=> Hash
resp.keys[0].dimensions["RequestString"] #=> String
resp.keys[0].total #=> Float
resp.keys[0].additional_metrics #=> Hash
resp.keys[0].additional_metrics["RequestString"] #=> Float
resp.keys[0].partitions #=> Array
resp.keys[0].partitions[0] #=> Float
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_type (required, String) —

    The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:

    • RDS

    • DOCDB

  • :identifier (required, String) —

    An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

    To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A.

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

    The date and time specifying the beginning of the requested time series data. You must specify a StartTime within the past 7 days. The value specified is inclusive, which means that data points equal to or greater than StartTime are returned.

    The value for StartTime must be earlier than the value for EndTime.

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

    The date and time specifying the end of the requested time series data. The value specified is exclusive, which means that data points less than (but not equal to) EndTime are returned.

    The value for EndTime must be later than the value for StartTime.

  • :metric (required, String) —

    The name of a Performance Insights metric to be measured.

    Valid values for Metric are:

    • db.load.avg - A scaled representation of the number of active sessions for the database engine.

    • db.sampledload.avg - The raw number of active sessions for the database engine.

    If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

  • :period_in_seconds (Integer) —

    The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:

    • 1 (one second)

    • 60 (one minute)

    • 300 (five minutes)

    • 3600 (one hour)

    • 86400 (twenty-four hours)

    If you don't specify PeriodInSeconds, then Performance Insights chooses a value for you, with a goal of returning roughly 100-200 data points in the response.

  • :group_by (required, Types::DimensionGroup) —

    A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.

  • :additional_metrics (Array<String>) —

    Additional metrics for the top N dimension keys. If the specified dimension group in the GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to get the values for the top N SQL digests. The response syntax is as follows: "AdditionalMetrics" : { "string" : "string" }.

    The only supported statistic function is .avg.

  • :partition_by (Types::DimensionGroup) —

    For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.

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

    One or more filters to apply in the request. Restrictions:

    • Any number of filters by the same dimension, as specified in the GroupBy or Partition parameters.

    • A single filter for any other dimension in this dimension group.

    The db.sql.db_id filter isn't available for RDS for SQL Server DB instances.

  • :max_results (Integer) —

    The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.

  • :next_token (String) —

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

Returns:

See Also:



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

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

#get_dimension_key_details(params = {}) ⇒ Types::GetDimensionKeyDetailsResponse

Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID. This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL statement text, lock snapshots, and execution plans.

Examples:

Request syntax with placeholder values


resp = client.get_dimension_key_details({
  service_type: "RDS", # required, accepts RDS, DOCDB
  identifier: "IdentifierString", # required
  group: "RequestString", # required
  group_identifier: "RequestString", # required
  requested_dimensions: ["SanitizedString"],
})

Response structure


resp.dimensions #=> Array
resp.dimensions[0].value #=> String
resp.dimensions[0].dimension #=> String
resp.dimensions[0].status #=> String, one of "AVAILABLE", "PROCESSING", "UNAVAILABLE"

Parameters:

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

    ({})

Options Hash (params):

  • :service_type (required, String) —

    The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.

  • :identifier (required, String) —

    The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

  • :group (required, String) —

    The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:

    • db.execution_plan (Amazon RDS and Aurora only)

    • db.lock_snapshot (Aurora only)

    • db.query (Amazon DocumentDB only)

    • db.sql (Amazon RDS and Aurora only)

  • :group_identifier (required, String) —

    The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql, the group ID is db.sql.id. The following group ID values are valid:

    • db.execution_plan.id for dimension group db.execution_plan (Aurora and RDS only)

    • db.sql.id for dimension group db.sql (Aurora and RDS only)

    • db.query.id for dimension group db.query (DocumentDB only)

    • For the dimension group db.lock_snapshot, the GroupIdentifier is the epoch timestamp when Performance Insights captured the snapshot, in seconds. You can retrieve this value with the GetResourceMetrics operation for a 1 second period.

  • :requested_dimensions (Array<String>) —

    A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:

    • db.execution_plan - Specify the dimension name db.execution_plan.raw_plan or the short dimension name raw_plan (Amazon RDS and Aurora only)

    • db.lock_snapshot - Specify the dimension name db.lock_snapshot.lock_trees or the short dimension name lock_trees. (Aurora only)

    • db.sql - Specify either the full dimension name db.sql.statement or the short dimension name statement (Aurora and RDS only).

    • db.query - Specify either the full dimension name db.query.statement or the short dimension name statement (DocumentDB only).

Returns:

See Also:



860
861
862
863
 
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 860

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

#get_performance_analysis_report(params = {}) ⇒ Types::GetPerformanceAnalysisReportResponse

Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be RUNNING, SUCCEEDED, or FAILED. The insights include the description and recommendation fields.

Examples:

Request syntax with placeholder values


resp = client.get_performance_analysis_report({
  service_type: "RDS", # required, accepts RDS, DOCDB
  identifier: "IdentifierString", # required
  analysis_report_id: "AnalysisReportId", # required
  text_format: "PLAIN_TEXT", # accepts PLAIN_TEXT, MARKDOWN
  accept_language: "EN_US", # accepts EN_US
})

Response structure


resp.analysis_report.analysis_report_id #=> String
resp.analysis_report.identifier #=> String
resp.analysis_report.service_type #=> String, one of "RDS", "DOCDB"
resp.analysis_report.create_time #=> Time
resp.analysis_report.start_time #=> Time
resp.analysis_report.end_time #=> Time
resp.analysis_report.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED"
resp.analysis_report.insights #=> Array
resp.analysis_report.insights[0].insight_id #=> String
resp.analysis_report.insights[0].insight_type #=> String
resp.analysis_report.insights[0].context #=> String, one of "CAUSAL", "CONTEXTUAL"
resp.analysis_report.insights[0].start_time #=> Time
resp.analysis_report.insights[0].end_time #=> Time
resp.analysis_report.insights[0].severity #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.analysis_report.insights[0].supporting_insights #=> Types::InsightList
resp.analysis_report.insights[0].description #=> String
resp.analysis_report.insights[0].recommendations #=> Array
resp.analysis_report.insights[0].recommendations[0].recommendation_id #=> String
resp.analysis_report.insights[0].recommendations[0].recommendation_description #=> String
resp.analysis_report.insights[0].insight_data #=> Array
resp.analysis_report.insights[0].insight_data[0].performance_insights_metric.metric #=> String
resp.analysis_report.insights[0].insight_data[0].performance_insights_metric.display_name #=> String
resp.analysis_report.insights[0].insight_data[0].performance_insights_metric.dimensions #=> Hash
resp.analysis_report.insights[0].insight_data[0].performance_insights_metric.dimensions["DescriptiveString"] #=> String
resp.analysis_report.insights[0].insight_data[0].performance_insights_metric.filter #=> Hash
resp.analysis_report.insights[0].insight_data[0].performance_insights_metric.filter["DescriptiveString"] #=> String
resp.analysis_report.insights[0].insight_data[0].performance_insights_metric.value #=> Float
resp.analysis_report.insights[0].baseline_data #=> Array
resp.analysis_report.insights[0].baseline_data[0].performance_insights_metric.metric #=> String
resp.analysis_report.insights[0].baseline_data[0].performance_insights_metric.display_name #=> String
resp.analysis_report.insights[0].baseline_data[0].performance_insights_metric.dimensions #=> Hash
resp.analysis_report.insights[0].baseline_data[0].performance_insights_metric.dimensions["DescriptiveString"] #=> String
resp.analysis_report.insights[0].baseline_data[0].performance_insights_metric.filter #=> Hash
resp.analysis_report.insights[0].baseline_data[0].performance_insights_metric.filter["DescriptiveString"] #=> String
resp.analysis_report.insights[0].baseline_data[0].performance_insights_metric.value #=> Float

Parameters:

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

    ({})

Options Hash (params):

  • :service_type (required, String) —

    The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.

  • :identifier (required, String) —

    An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

    To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

  • :analysis_report_id (required, String) —

    A unique identifier of the created analysis report. For example, report-12345678901234567

  • :text_format (String) —

    Indicates the text format in the report. The options are PLAIN_TEXT or MARKDOWN. The default value is plain text.

  • :accept_language (String) —

    The text language in the report. The default language is EN_US (English).

Returns:

See Also:



952
953
954
955
 
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 952

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

#get_resource_metadata(params = {}) ⇒ Types::GetResourceMetadataResponse

Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

Examples:

Request syntax with placeholder values


resp = client.get_resource_metadata({
  service_type: "RDS", # required, accepts RDS, DOCDB
  identifier: "IdentifierString", # required
})

Response structure


resp.identifier #=> String
resp.features #=> Hash
resp.features["String"].status #=> String, one of "ENABLED", "DISABLED", "UNSUPPORTED", "ENABLED_PENDING_REBOOT", "DISABLED_PENDING_REBOOT", "UNKNOWN"

Parameters:

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

    ({})

Options Hash (params):

  • :service_type (required, String) —

    The Amazon Web Services service for which Performance Insights returns metrics.

  • :identifier (required, String) —

    An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

Returns:

See Also:



994
995
996
997
 
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 994

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

#get_resource_metrics(params = {}) ⇒ Types::GetResourceMetricsResponse

Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide filtering criteria for each group. You must specify an aggregate function for each metric.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

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

Examples:

Request syntax with placeholder values


resp = client.get_resource_metrics({
  service_type: "RDS", # required, accepts RDS, DOCDB
  identifier: "IdentifierString", # required
  metric_queries: [ # required
    {
      metric: "SanitizedString", # required
      group_by: {
        group: "SanitizedString", # required
        dimensions: ["SanitizedString"],
        limit: 1,
      },
      filter: {
        "SanitizedString" => "RequestString",
      },
    },
  ],
  start_time: Time.now, # required
  end_time: Time.now, # required
  period_in_seconds: 1,
  max_results: 1,
  next_token: "NextToken",
  period_alignment: "END_TIME", # accepts END_TIME, START_TIME
})

Response structure


resp.aligned_start_time #=> Time
resp.aligned_end_time #=> Time
resp.identifier #=> String
resp.metric_list #=> Array
resp.metric_list[0].key.metric #=> String
resp.metric_list[0].key.dimensions #=> Hash
resp.metric_list[0].key.dimensions["RequestString"] #=> String
resp.metric_list[0].data_points #=> Array
resp.metric_list[0].data_points[0].timestamp #=> Time
resp.metric_list[0].data_points[0].value #=> Float
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_type (required, String) —

    The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

    • RDS

    • DOCDB

  • :identifier (required, String) —

    An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

    To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

  • :metric_queries (required, Array<Types::MetricQuery>) —

    An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric db.load you must use db.load.avg. Valid values for aggregate functions include .avg, .min, .max, and .sum.

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

    The date and time specifying the beginning of the requested time series query range. You can't specify a StartTime that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is inclusive. Thus, the command returns data points equal to or greater than StartTime.

    The value for StartTime must be earlier than the value for EndTime.

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

    The date and time specifying the end of the requested time series query range. The value specified is exclusive. Thus, the command returns data points less than (but not equal to) EndTime.

    The value for EndTime must be later than the value for StartTime.

  • :period_in_seconds (Integer) —

    The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:

    • 1 (one second)

    • 60 (one minute)

    • 300 (five minutes)

    • 3600 (one hour)

    • 86400 (twenty-four hours)

    If you don't specify PeriodInSeconds, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.

  • :max_results (Integer) —

    The maximum number of items to return in the response.

  • :next_token (String) —

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

  • :period_alignment (String) —

    The returned timestamp which is the start or end time of the time periods. The default value is END_TIME.

Returns:

See Also:



1139
1140
1141
1142
 
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1139

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

#list_available_resource_dimensions(params = {}) ⇒ Types::ListAvailableResourceDimensionsResponse

Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.

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_available_resource_dimensions({
  service_type: "RDS", # required, accepts RDS, DOCDB
  identifier: "IdentifierString", # required
  metrics: ["SanitizedString"], # required
  max_results: 1,
  next_token: "NextToken",
  authorized_actions: ["DescribeDimensionKeys"], # accepts DescribeDimensionKeys, GetDimensionKeyDetails, GetResourceMetrics
})

Response structure


resp.metric_dimensions #=> Array
resp.metric_dimensions[0].metric #=> String
resp.metric_dimensions[0].groups #=> Array
resp.metric_dimensions[0].groups[0].group #=> String
resp.metric_dimensions[0].groups[0].dimensions #=> Array
resp.metric_dimensions[0].groups[0].dimensions[0].identifier #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_type (required, String) —

    The Amazon Web Services service for which Performance Insights returns metrics.

  • :identifier (required, String) —

    An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.

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

    The types of metrics for which to retrieve dimensions. Valid values include db.load.

  • :max_results (Integer) —

    The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.

  • :next_token (String) —

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

  • :authorized_actions (Array<String>) —

    The actions to discover the dimensions you are authorized to access. If you specify multiple actions, then the response will contain the dimensions common for all the actions.

    When you don't specify this request parameter or provide an empty list, the response contains all the available dimensions for the target database engine whether or not you are authorized to access them.

Returns:

See Also:



1215
1216
1217
1218
 
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1215

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

#list_available_resource_metrics(params = {}) ⇒ Types::ListAvailableResourceMetricsResponse

Retrieve metrics of the specified types that can be queried for a specified DB instance.

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_available_resource_metrics({
  service_type: "RDS", # required, accepts RDS, DOCDB
  identifier: "IdentifierString", # required
  metric_types: ["SanitizedString"], # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.metrics #=> Array
resp.metrics[0].metric #=> String
resp.metrics[0].description #=> String
resp.metrics[0].unit #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_type (required, String) —

    The Amazon Web Services service for which Performance Insights returns metrics.

  • :identifier (required, String) —

    An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.

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

    The types of metrics to return in the response. Valid values in the array include the following:

    • os (OS counter metrics) - All engines

    • db (DB load metrics) - All engines except for Amazon DocumentDB

    • db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB

    • db.sql_tokenized.stats (per-SQL digest metrics) - All engines except for Amazon DocumentDB

  • :next_token (String) —

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

  • :max_results (Integer) —

    The maximum number of items to return. If the MaxRecords value is less than the number of existing items, the response includes a pagination token.

Returns:

See Also:



1287
1288
1289
1290
 
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1287

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

#list_performance_analysis_reports(params = {}) ⇒ Types::ListPerformanceAnalysisReportsResponse

Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.

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_performance_analysis_reports({
  service_type: "RDS", # required, accepts RDS, DOCDB
  identifier: "IdentifierString", # required
  next_token: "NextToken",
  max_results: 1,
  list_tags: false,
})

Response structure


resp.analysis_reports #=> Array
resp.analysis_reports[0].analysis_report_id #=> String
resp.analysis_reports[0].create_time #=> Time
resp.analysis_reports[0].start_time #=> Time
resp.analysis_reports[0].end_time #=> Time
resp.analysis_reports[0].status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED"
resp.analysis_reports[0].tags #=> Array
resp.analysis_reports[0].tags[0].key #=> String
resp.analysis_reports[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_type (required, String) —

    The Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.

  • :identifier (required, String) —

    An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

    To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

  • :next_token (String) —

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults.

  • :max_results (Integer) —

    The maximum number of items to return in the response. If more items exist than the specified MaxResults value, a pagination token is included in the response so that the remaining results can be retrieved.

  • :list_tags (Boolean) —

    Specifies whether or not to include the list of tags in the response.

Returns:

See Also:



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

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

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

Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :service_type (required, String) —

    List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.

  • :resource_arn (required, String) —

    Lists all the tags for the Amazon RDS Performance Insights resource. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

Returns:

See Also:



1400
1401
1402
1403
 
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1400

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

#tag_resource(params = {}) ⇒ Struct

Adds metadata tags to the Amazon RDS Performance Insights resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :service_type (required, String) —

    The Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.

  • :resource_arn (required, String) —

    The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

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

    The metadata assigned to an Amazon RDS resource consisting of a key-value pair.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1444
1445
1446
1447
 
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1444

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

#untag_resource(params = {}) ⇒ Struct

Deletes the metadata tags from the Amazon RDS Performance Insights resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :service_type (required, String) —

    List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.

  • :resource_arn (required, String) —

    The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

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

    The metadata assigned to an Amazon RDS Performance Insights resource consisting of a key-value pair.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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