Struct aws_sdk_pi::Client

source · [−]
pub struct Client { /* private fields */ }
Expand description

Client for AWS Performance Insights

Client for invoking operations on AWS Performance Insights. Each operation on AWS Performance Insights is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_pi::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_pi::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_pi::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the DescribeDimensionKeys operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • service_type(ServiceType) / set_service_type(Option<ServiceType>):

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

      • RDS

      • DOCDB

    • identifier(impl Into<String>) / set_identifier(Option<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(DateTime) / set_start_time(Option<DateTime>):

      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(DateTime) / set_end_time(Option<DateTime>):

      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(impl Into<String>) / set_metric(Option<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(i32) / set_period_in_seconds(Option<i32>):

      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(DimensionGroup) / set_group_by(Option<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(Vec<String>) / set_additional_metrics(Option<Vec<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” }.

    • partition_by(DimensionGroup) / set_partition_by(Option<DimensionGroup>):

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

    • filter(HashMap<String, String>) / set_filter(Option<HashMap<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.

    • max_results(i32) / set_max_results(Option<i32>):

      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(impl Into<String>) / set_next_token(Option<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.

  • On success, responds with DescribeDimensionKeysOutput with field(s):
    • aligned_start_time(Option<DateTime>):

      The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.

    • aligned_end_time(Option<DateTime>):

      The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.

    • partition_keys(Option<Vec<ResponsePartitionKey>>):

      If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.

    • keys(Option<Vec<DimensionKeyDescription>>):

      The dimension keys that were requested.

    • next_token(Option<String>):

      A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the previous request. To get the remaining records, specify NextToken in a separate request with this value.

  • On failure, responds with SdkError<DescribeDimensionKeysError>

Constructs a fluent builder for the GetDimensionKeyDetails operation.

Constructs a fluent builder for the GetResourceMetadata operation.

Constructs a fluent builder for the GetResourceMetrics operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • service_type(ServiceType) / set_service_type(Option<ServiceType>):

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

      • RDS

      • DOCDB

    • identifier(impl Into<String>) / set_identifier(Option<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(Vec<MetricQuery>) / set_metric_queries(Option<Vec<MetricQuery>>):

      An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering criteria.

    • start_time(DateTime) / set_start_time(Option<DateTime>):

      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(DateTime) / set_end_time(Option<DateTime>):

      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(i32) / set_period_in_seconds(Option<i32>):

      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(i32) / set_max_results(Option<i32>):

      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(impl Into<String>) / set_next_token(Option<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.

  • On success, responds with GetResourceMetricsOutput with field(s):
    • aligned_start_time(Option<DateTime>):

      The start time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.

    • aligned_end_time(Option<DateTime>):

      The end time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.

    • identifier(Option<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.

    • metric_list(Option<Vec<MetricKeyDataPoints>>):

      An array of metric results, where each array element contains all of the data points for a particular dimension.

    • next_token(Option<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.

  • On failure, responds with SdkError<GetResourceMetricsError>

Constructs a fluent builder for the ListAvailableResourceDimensions operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListAvailableResourceMetrics operation. This operation supports pagination; See into_paginator().

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more