AWS SDK for C++  1.9.20
AWS SDK for C++
Public Member Functions | List of all members
Aws::PI::Model::DescribeDimensionKeysRequest Class Reference

#include <DescribeDimensionKeysRequest.h>

+ Inheritance diagram for Aws::PI::Model::DescribeDimensionKeysRequest:

Public Member Functions

 DescribeDimensionKeysRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const ServiceTypeGetServiceType () const
 
bool ServiceTypeHasBeenSet () const
 
void SetServiceType (const ServiceType &value)
 
void SetServiceType (ServiceType &&value)
 
DescribeDimensionKeysRequestWithServiceType (const ServiceType &value)
 
DescribeDimensionKeysRequestWithServiceType (ServiceType &&value)
 
const Aws::StringGetIdentifier () const
 
bool IdentifierHasBeenSet () const
 
void SetIdentifier (const Aws::String &value)
 
void SetIdentifier (Aws::String &&value)
 
void SetIdentifier (const char *value)
 
DescribeDimensionKeysRequestWithIdentifier (const Aws::String &value)
 
DescribeDimensionKeysRequestWithIdentifier (Aws::String &&value)
 
DescribeDimensionKeysRequestWithIdentifier (const char *value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
DescribeDimensionKeysRequestWithStartTime (const Aws::Utils::DateTime &value)
 
DescribeDimensionKeysRequestWithStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetEndTime () const
 
bool EndTimeHasBeenSet () const
 
void SetEndTime (const Aws::Utils::DateTime &value)
 
void SetEndTime (Aws::Utils::DateTime &&value)
 
DescribeDimensionKeysRequestWithEndTime (const Aws::Utils::DateTime &value)
 
DescribeDimensionKeysRequestWithEndTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetMetric () const
 
bool MetricHasBeenSet () const
 
void SetMetric (const Aws::String &value)
 
void SetMetric (Aws::String &&value)
 
void SetMetric (const char *value)
 
DescribeDimensionKeysRequestWithMetric (const Aws::String &value)
 
DescribeDimensionKeysRequestWithMetric (Aws::String &&value)
 
DescribeDimensionKeysRequestWithMetric (const char *value)
 
int GetPeriodInSeconds () const
 
bool PeriodInSecondsHasBeenSet () const
 
void SetPeriodInSeconds (int value)
 
DescribeDimensionKeysRequestWithPeriodInSeconds (int value)
 
const DimensionGroupGetGroupBy () const
 
bool GroupByHasBeenSet () const
 
void SetGroupBy (const DimensionGroup &value)
 
void SetGroupBy (DimensionGroup &&value)
 
DescribeDimensionKeysRequestWithGroupBy (const DimensionGroup &value)
 
DescribeDimensionKeysRequestWithGroupBy (DimensionGroup &&value)
 
const DimensionGroupGetPartitionBy () const
 
bool PartitionByHasBeenSet () const
 
void SetPartitionBy (const DimensionGroup &value)
 
void SetPartitionBy (DimensionGroup &&value)
 
DescribeDimensionKeysRequestWithPartitionBy (const DimensionGroup &value)
 
DescribeDimensionKeysRequestWithPartitionBy (DimensionGroup &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetFilter () const
 
bool FilterHasBeenSet () const
 
void SetFilter (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetFilter (Aws::Map< Aws::String, Aws::String > &&value)
 
DescribeDimensionKeysRequestWithFilter (const Aws::Map< Aws::String, Aws::String > &value)
 
DescribeDimensionKeysRequestWithFilter (Aws::Map< Aws::String, Aws::String > &&value)
 
DescribeDimensionKeysRequestAddFilter (const Aws::String &key, const Aws::String &value)
 
DescribeDimensionKeysRequestAddFilter (Aws::String &&key, const Aws::String &value)
 
DescribeDimensionKeysRequestAddFilter (const Aws::String &key, Aws::String &&value)
 
DescribeDimensionKeysRequestAddFilter (Aws::String &&key, Aws::String &&value)
 
DescribeDimensionKeysRequestAddFilter (const char *key, Aws::String &&value)
 
DescribeDimensionKeysRequestAddFilter (Aws::String &&key, const char *value)
 
DescribeDimensionKeysRequestAddFilter (const char *key, const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeDimensionKeysRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeDimensionKeysRequestWithNextToken (const Aws::String &value)
 
DescribeDimensionKeysRequestWithNextToken (Aws::String &&value)
 
DescribeDimensionKeysRequestWithNextToken (const char *value)
 
- Public Member Functions inherited from Aws::PI::PIRequest
virtual ~PIRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 25 of file DescribeDimensionKeysRequest.h.

Constructor & Destructor Documentation

◆ DescribeDimensionKeysRequest()

Aws::PI::Model::DescribeDimensionKeysRequest::DescribeDimensionKeysRequest ( )

Member Function Documentation

◆ AddFilter() [1/7]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::AddFilter ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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.

Definition at line 611 of file DescribeDimensionKeysRequest.h.

◆ AddFilter() [2/7]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::AddFilter ( Aws::String &&  key,
const Aws::String value 
)
inline

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.

Definition at line 595 of file DescribeDimensionKeysRequest.h.

◆ AddFilter() [3/7]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::AddFilter ( Aws::String &&  key,
const char *  value 
)
inline

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.

Definition at line 627 of file DescribeDimensionKeysRequest.h.

◆ AddFilter() [4/7]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::AddFilter ( const Aws::String key,
Aws::String &&  value 
)
inline

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.

Definition at line 603 of file DescribeDimensionKeysRequest.h.

◆ AddFilter() [5/7]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::AddFilter ( const Aws::String key,
const Aws::String value 
)
inline

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.

Definition at line 587 of file DescribeDimensionKeysRequest.h.

◆ AddFilter() [6/7]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::AddFilter ( const char *  key,
Aws::String &&  value 
)
inline

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.

Definition at line 619 of file DescribeDimensionKeysRequest.h.

◆ AddFilter() [7/7]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::AddFilter ( const char *  key,
const char *  value 
)
inline

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.

Definition at line 635 of file DescribeDimensionKeysRequest.h.

◆ EndTimeHasBeenSet()

bool Aws::PI::Model::DescribeDimensionKeysRequest::EndTimeHasBeenSet ( ) const
inline

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.

Definition at line 220 of file DescribeDimensionKeysRequest.h.

◆ FilterHasBeenSet()

bool Aws::PI::Model::DescribeDimensionKeysRequest::FilterHasBeenSet ( ) const
inline

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.

Definition at line 547 of file DescribeDimensionKeysRequest.h.

◆ GetEndTime()

const Aws::Utils::DateTime& Aws::PI::Model::DescribeDimensionKeysRequest::GetEndTime ( ) const
inline

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.

Definition at line 211 of file DescribeDimensionKeysRequest.h.

◆ GetFilter()

const Aws::Map<Aws::String, Aws::String>& Aws::PI::Model::DescribeDimensionKeysRequest::GetFilter ( ) const
inline

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.

Definition at line 539 of file DescribeDimensionKeysRequest.h.

◆ GetGroupBy()

const DimensionGroup& Aws::PI::Model::DescribeDimensionKeysRequest::GetGroupBy ( ) const
inline

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.

Definition at line 448 of file DescribeDimensionKeysRequest.h.

◆ GetIdentifier()

const Aws::String& Aws::PI::Model::DescribeDimensionKeysRequest::GetIdentifier ( ) const
inline

An immutable, AWS 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

Definition at line 84 of file DescribeDimensionKeysRequest.h.

◆ GetMaxResults()

int Aws::PI::Model::DescribeDimensionKeysRequest::GetMaxResults ( ) const
inline

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.

Definition at line 643 of file DescribeDimensionKeysRequest.h.

◆ GetMetric()

const Aws::String& Aws::PI::Model::DescribeDimensionKeysRequest::GetMetric ( ) const
inline

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.

Definition at line 273 of file DescribeDimensionKeysRequest.h.

◆ GetNextToken()

const Aws::String& Aws::PI::Model::DescribeDimensionKeysRequest::GetNextToken ( ) const
inline

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.

Definition at line 672 of file DescribeDimensionKeysRequest.h.

◆ GetPartitionBy()

const DimensionGroup& Aws::PI::Model::DescribeDimensionKeysRequest::GetPartitionBy ( ) const
inline

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

Definition at line 500 of file DescribeDimensionKeysRequest.h.

◆ GetPeriodInSeconds()

int Aws::PI::Model::DescribeDimensionKeysRequest::GetPeriodInSeconds ( ) const
inline

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.

Definition at line 399 of file DescribeDimensionKeysRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::PI::Model::DescribeDimensionKeysRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::PI::PIRequest.

◆ GetServiceRequestName()

virtual const char* Aws::PI::Model::DescribeDimensionKeysRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DescribeDimensionKeysRequest.h.

◆ GetServiceType()

const ServiceType& Aws::PI::Model::DescribeDimensionKeysRequest::GetServiceType ( ) const
inline

The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is RDS.

Definition at line 45 of file DescribeDimensionKeysRequest.h.

◆ GetStartTime()

const Aws::Utils::DateTime& Aws::PI::Model::DescribeDimensionKeysRequest::GetStartTime ( ) const
inline

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.

Definition at line 151 of file DescribeDimensionKeysRequest.h.

◆ GroupByHasBeenSet()

bool Aws::PI::Model::DescribeDimensionKeysRequest::GroupByHasBeenSet ( ) const
inline

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.

Definition at line 457 of file DescribeDimensionKeysRequest.h.

◆ IdentifierHasBeenSet()

bool Aws::PI::Model::DescribeDimensionKeysRequest::IdentifierHasBeenSet ( ) const
inline

An immutable, AWS 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

Definition at line 92 of file DescribeDimensionKeysRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::PI::Model::DescribeDimensionKeysRequest::MaxResultsHasBeenSet ( ) const
inline

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.

Definition at line 650 of file DescribeDimensionKeysRequest.h.

◆ MetricHasBeenSet()

bool Aws::PI::Model::DescribeDimensionKeysRequest::MetricHasBeenSet ( ) const
inline

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.

Definition at line 289 of file DescribeDimensionKeysRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::PI::Model::DescribeDimensionKeysRequest::NextTokenHasBeenSet ( ) const
inline

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.

Definition at line 679 of file DescribeDimensionKeysRequest.h.

◆ PartitionByHasBeenSet()

bool Aws::PI::Model::DescribeDimensionKeysRequest::PartitionByHasBeenSet ( ) const
inline

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

Definition at line 506 of file DescribeDimensionKeysRequest.h.

◆ PeriodInSecondsHasBeenSet()

bool Aws::PI::Model::DescribeDimensionKeysRequest::PeriodInSecondsHasBeenSet ( ) const
inline

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.

Definition at line 412 of file DescribeDimensionKeysRequest.h.

◆ SerializePayload()

Aws::String Aws::PI::Model::DescribeDimensionKeysRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServiceTypeHasBeenSet()

bool Aws::PI::Model::DescribeDimensionKeysRequest::ServiceTypeHasBeenSet ( ) const
inline

The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is RDS.

Definition at line 51 of file DescribeDimensionKeysRequest.h.

◆ SetEndTime() [1/2]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetEndTime ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 238 of file DescribeDimensionKeysRequest.h.

◆ SetEndTime() [2/2]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetEndTime ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 229 of file DescribeDimensionKeysRequest.h.

◆ SetFilter() [1/2]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetFilter ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 563 of file DescribeDimensionKeysRequest.h.

◆ SetFilter() [2/2]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetFilter ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 555 of file DescribeDimensionKeysRequest.h.

◆ SetGroupBy() [1/2]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetGroupBy ( const DimensionGroup value)
inline

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.

Definition at line 466 of file DescribeDimensionKeysRequest.h.

◆ SetGroupBy() [2/2]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetGroupBy ( DimensionGroup &&  value)
inline

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.

Definition at line 475 of file DescribeDimensionKeysRequest.h.

◆ SetIdentifier() [1/3]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetIdentifier ( Aws::String &&  value)
inline

An immutable, AWS 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

Definition at line 108 of file DescribeDimensionKeysRequest.h.

◆ SetIdentifier() [2/3]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetIdentifier ( const Aws::String value)
inline

An immutable, AWS 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

Definition at line 100 of file DescribeDimensionKeysRequest.h.

◆ SetIdentifier() [3/3]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetIdentifier ( const char *  value)
inline

An immutable, AWS 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

Definition at line 116 of file DescribeDimensionKeysRequest.h.

◆ SetMaxResults()

void Aws::PI::Model::DescribeDimensionKeysRequest::SetMaxResults ( int  value)
inline

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.

Definition at line 657 of file DescribeDimensionKeysRequest.h.

◆ SetMetric() [1/3]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetMetric ( Aws::String &&  value)
inline

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.

Definition at line 321 of file DescribeDimensionKeysRequest.h.

◆ SetMetric() [2/3]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetMetric ( const Aws::String value)
inline

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.

Definition at line 305 of file DescribeDimensionKeysRequest.h.

◆ SetMetric() [3/3]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetMetric ( const char *  value)
inline

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.

Definition at line 337 of file DescribeDimensionKeysRequest.h.

◆ SetNextToken() [1/3]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetNextToken ( Aws::String &&  value)
inline

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.

Definition at line 693 of file DescribeDimensionKeysRequest.h.

◆ SetNextToken() [2/3]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetNextToken ( const Aws::String value)
inline

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.

Definition at line 686 of file DescribeDimensionKeysRequest.h.

◆ SetNextToken() [3/3]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetNextToken ( const char *  value)
inline

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.

Definition at line 700 of file DescribeDimensionKeysRequest.h.

◆ SetPartitionBy() [1/2]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetPartitionBy ( const DimensionGroup value)
inline

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

Definition at line 512 of file DescribeDimensionKeysRequest.h.

◆ SetPartitionBy() [2/2]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetPartitionBy ( DimensionGroup &&  value)
inline

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

Definition at line 518 of file DescribeDimensionKeysRequest.h.

◆ SetPeriodInSeconds()

void Aws::PI::Model::DescribeDimensionKeysRequest::SetPeriodInSeconds ( int  value)
inline

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.

Definition at line 425 of file DescribeDimensionKeysRequest.h.

◆ SetServiceType() [1/2]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetServiceType ( const ServiceType value)
inline

The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is RDS.

Definition at line 57 of file DescribeDimensionKeysRequest.h.

◆ SetServiceType() [2/2]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetServiceType ( ServiceType &&  value)
inline

The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is RDS.

Definition at line 63 of file DescribeDimensionKeysRequest.h.

◆ SetStartTime() [1/2]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetStartTime ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 181 of file DescribeDimensionKeysRequest.h.

◆ SetStartTime() [2/2]

void Aws::PI::Model::DescribeDimensionKeysRequest::SetStartTime ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 171 of file DescribeDimensionKeysRequest.h.

◆ StartTimeHasBeenSet()

bool Aws::PI::Model::DescribeDimensionKeysRequest::StartTimeHasBeenSet ( ) const
inline

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.

Definition at line 161 of file DescribeDimensionKeysRequest.h.

◆ WithEndTime() [1/2]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithEndTime ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 256 of file DescribeDimensionKeysRequest.h.

◆ WithEndTime() [2/2]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithEndTime ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 247 of file DescribeDimensionKeysRequest.h.

◆ WithFilter() [1/2]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithFilter ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 579 of file DescribeDimensionKeysRequest.h.

◆ WithFilter() [2/2]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithFilter ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 571 of file DescribeDimensionKeysRequest.h.

◆ WithGroupBy() [1/2]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithGroupBy ( const DimensionGroup value)
inline

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.

Definition at line 484 of file DescribeDimensionKeysRequest.h.

◆ WithGroupBy() [2/2]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithGroupBy ( DimensionGroup &&  value)
inline

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.

Definition at line 493 of file DescribeDimensionKeysRequest.h.

◆ WithIdentifier() [1/3]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithIdentifier ( Aws::String &&  value)
inline

An immutable, AWS 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

Definition at line 132 of file DescribeDimensionKeysRequest.h.

◆ WithIdentifier() [2/3]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithIdentifier ( const Aws::String value)
inline

An immutable, AWS 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

Definition at line 124 of file DescribeDimensionKeysRequest.h.

◆ WithIdentifier() [3/3]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithIdentifier ( const char *  value)
inline

An immutable, AWS 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

Definition at line 140 of file DescribeDimensionKeysRequest.h.

◆ WithMaxResults()

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithMaxResults ( int  value)
inline

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.

Definition at line 664 of file DescribeDimensionKeysRequest.h.

◆ WithMetric() [1/3]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithMetric ( Aws::String &&  value)
inline

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.

Definition at line 369 of file DescribeDimensionKeysRequest.h.

◆ WithMetric() [2/3]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithMetric ( const Aws::String value)
inline

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.

Definition at line 353 of file DescribeDimensionKeysRequest.h.

◆ WithMetric() [3/3]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithMetric ( const char *  value)
inline

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.

Definition at line 385 of file DescribeDimensionKeysRequest.h.

◆ WithNextToken() [1/3]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithNextToken ( Aws::String &&  value)
inline

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.

Definition at line 714 of file DescribeDimensionKeysRequest.h.

◆ WithNextToken() [2/3]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithNextToken ( const Aws::String value)
inline

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.

Definition at line 707 of file DescribeDimensionKeysRequest.h.

◆ WithNextToken() [3/3]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithNextToken ( const char *  value)
inline

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.

Definition at line 721 of file DescribeDimensionKeysRequest.h.

◆ WithPartitionBy() [1/2]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithPartitionBy ( const DimensionGroup value)
inline

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

Definition at line 524 of file DescribeDimensionKeysRequest.h.

◆ WithPartitionBy() [2/2]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithPartitionBy ( DimensionGroup &&  value)
inline

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

Definition at line 530 of file DescribeDimensionKeysRequest.h.

◆ WithPeriodInSeconds()

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithPeriodInSeconds ( int  value)
inline

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.

Definition at line 438 of file DescribeDimensionKeysRequest.h.

◆ WithServiceType() [1/2]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithServiceType ( const ServiceType value)
inline

The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is RDS.

Definition at line 69 of file DescribeDimensionKeysRequest.h.

◆ WithServiceType() [2/2]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithServiceType ( ServiceType &&  value)
inline

The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is RDS.

Definition at line 75 of file DescribeDimensionKeysRequest.h.

◆ WithStartTime() [1/2]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithStartTime ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 201 of file DescribeDimensionKeysRequest.h.

◆ WithStartTime() [2/2]

DescribeDimensionKeysRequest& Aws::PI::Model::DescribeDimensionKeysRequest::WithStartTime ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 191 of file DescribeDimensionKeysRequest.h.


The documentation for this class was generated from the following file: