Class: Aws::PI::Types::ListAvailableResourceDimensionsRequest

Inherits:

Struct

• Object
• Struct
• Aws::PI::Types::ListAvailableResourceDimensionsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-pi/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #authorized_actions ⇒ Array<String>

  The actions to discover the dimensions you are authorized to access.

• #identifier ⇒ String

  An immutable identifier for a data source that is unique within an Amazon Web Services Region.

• #max_results ⇒ Integer

  The maximum number of items to return in the response.

• #metrics ⇒ Array<String>

  The types of metrics for which to retrieve dimensions.

• #next_token ⇒ String

  An optional pagination token provided by a previous request.

• #service_type ⇒ String

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

Instance Attribute Details

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

• (Array<String>)

# File 'lib/aws-sdk-pi/types.rb', line 1232

class ListAvailableResourceDimensionsRequest < Struct.new(
  :service_type,
  :identifier,
  :metrics,
  :max_results,
  :next_token,
  :authorized_actions)
  SENSITIVE = []
  include Aws::Structure
end

#identifier ⇒ 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`.

Returns:

• (String)

# File 'lib/aws-sdk-pi/types.rb', line 1232

class ListAvailableResourceDimensionsRequest < Struct.new(
  :service_type,
  :identifier,
  :metrics,
  :max_results,
  :next_token,
  :authorized_actions)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (Integer)

# File 'lib/aws-sdk-pi/types.rb', line 1232

class ListAvailableResourceDimensionsRequest < Struct.new(
  :service_type,
  :identifier,
  :metrics,
  :max_results,
  :next_token,
  :authorized_actions)
  SENSITIVE = []
  include Aws::Structure
end

#metrics ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-pi/types.rb', line 1232

class ListAvailableResourceDimensionsRequest < Struct.new(
  :service_type,
  :identifier,
  :metrics,
  :max_results,
  :next_token,
  :authorized_actions)
  SENSITIVE = []
  include Aws::Structure
end

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

• (String)

# File 'lib/aws-sdk-pi/types.rb', line 1232

class ListAvailableResourceDimensionsRequest < Struct.new(
  :service_type,
  :identifier,
  :metrics,
  :max_results,
  :next_token,
  :authorized_actions)
  SENSITIVE = []
  include Aws::Structure
end

#service_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-pi/types.rb', line 1232

class ListAvailableResourceDimensionsRequest < Struct.new(
  :service_type,
  :identifier,
  :metrics,
  :max_results,
  :next_token,
  :authorized_actions)
  SENSITIVE = []
  include Aws::Structure
end