Class: Aws::PI::Types::GetDimensionKeyDetailsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-pi/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#group ⇒ 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)

Returns:

  • (String) 


868
869
870
871
872
873
874
875
876
 
# File 'lib/aws-sdk-pi/types.rb', line 868

class GetDimensionKeyDetailsRequest < Struct.new(
  :service_type,
  :identifier,
  :group,
  :group_identifier,
  :requested_dimensions)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String) 


868
869
870
871
872
873
874
875
876
 
# File 'lib/aws-sdk-pi/types.rb', line 868

class GetDimensionKeyDetailsRequest < Struct.new(
  :service_type,
  :identifier,
  :group,
  :group_identifier,
  :requested_dimensions)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String) 


868
869
870
871
872
873
874
875
876
 
# File 'lib/aws-sdk-pi/types.rb', line 868

class GetDimensionKeyDetailsRequest < Struct.new(
  :service_type,
  :identifier,
  :group,
  :group_identifier,
  :requested_dimensions)
  SENSITIVE = []
  include Aws::Structure
end

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

  • (Array<String>) 


868
869
870
871
872
873
874
875
876
 
# File 'lib/aws-sdk-pi/types.rb', line 868

class GetDimensionKeyDetailsRequest < Struct.new(
  :service_type,
  :identifier,
  :group,
  :group_identifier,
  :requested_dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#service_type ⇒ String

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

Returns:

  • (String) 


868
869
870
871
872
873
874
875
876
 
# File 'lib/aws-sdk-pi/types.rb', line 868

class GetDimensionKeyDetailsRequest < Struct.new(
  :service_type,
  :identifier,
  :group,
  :group_identifier,
  :requested_dimensions)
  SENSITIVE = []
  include Aws::Structure
end