aws_sdk_pi/client/

list_available_resource_dimensions.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListAvailableResourceDimensions`](crate::operation::list_available_resource_dimensions::builders::ListAvailableResourceDimensionsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_available_resource_dimensions::builders::ListAvailableResourceDimensionsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`service_type(ServiceType)`](crate::operation::list_available_resource_dimensions::builders::ListAvailableResourceDimensionsFluentBuilder::service_type) / [`set_service_type(Option<ServiceType>)`](crate::operation::list_available_resource_dimensions::builders::ListAvailableResourceDimensionsFluentBuilder::set_service_type):<br>required: **true**<br><p>The Amazon Web Services service for which Performance Insights returns metrics.</p><br>
    ///   - [`identifier(impl Into<String>)`](crate::operation::list_available_resource_dimensions::builders::ListAvailableResourceDimensionsFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::list_available_resource_dimensions::builders::ListAvailableResourceDimensionsFluentBuilder::set_identifier):<br>required: **true**<br><p>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 <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VWZ</code>.</p><br>
    ///   - [`metrics(impl Into<String>)`](crate::operation::list_available_resource_dimensions::builders::ListAvailableResourceDimensionsFluentBuilder::metrics) / [`set_metrics(Option<Vec::<String>>)`](crate::operation::list_available_resource_dimensions::builders::ListAvailableResourceDimensionsFluentBuilder::set_metrics):<br>required: **true**<br><p>The types of metrics for which to retrieve dimensions. Valid values include <code>db.load</code>.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_available_resource_dimensions::builders::ListAvailableResourceDimensionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_available_resource_dimensions::builders::ListAvailableResourceDimensionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to return in the response. If more items exist than the specified <code>MaxRecords</code> value, a pagination token is included in the response so that the remaining results can be retrieved.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_available_resource_dimensions::builders::ListAvailableResourceDimensionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_available_resource_dimensions::builders::ListAvailableResourceDimensionsFluentBuilder::set_next_token):<br>required: **false**<br><p>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 <code>MaxRecords</code>.</p><br>
    ///   - [`authorized_actions(FineGrainedAction)`](crate::operation::list_available_resource_dimensions::builders::ListAvailableResourceDimensionsFluentBuilder::authorized_actions) / [`set_authorized_actions(Option<Vec::<FineGrainedAction>>)`](crate::operation::list_available_resource_dimensions::builders::ListAvailableResourceDimensionsFluentBuilder::set_authorized_actions):<br>required: **false**<br><p>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.</p> <p>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.</p><br>
    /// - On success, responds with [`ListAvailableResourceDimensionsOutput`](crate::operation::list_available_resource_dimensions::ListAvailableResourceDimensionsOutput) with field(s):
    ///   - [`metric_dimensions(Option<Vec::<MetricDimensionGroups>>)`](crate::operation::list_available_resource_dimensions::ListAvailableResourceDimensionsOutput::metric_dimensions): <p>The dimension information returned for requested metric types.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_available_resource_dimensions::ListAvailableResourceDimensionsOutput::next_token): <p>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 <code>MaxRecords</code>.</p>
    /// - On failure, responds with [`SdkError<ListAvailableResourceDimensionsError>`](crate::operation::list_available_resource_dimensions::ListAvailableResourceDimensionsError)
    pub fn list_available_resource_dimensions(
        &self,
    ) -> crate::operation::list_available_resource_dimensions::builders::ListAvailableResourceDimensionsFluentBuilder {
        crate::operation::list_available_resource_dimensions::builders::ListAvailableResourceDimensionsFluentBuilder::new(self.handle.clone())
    }
}