Skip to content

DimensionKeyDetail

Source code in docs_src/capo_pi/types/dimension_key_detail.py 
12
13
14
15
16
17
18
class DimensionKeyDetail(TypedDict, closed=True):
    value: NotRequired["capo_pi.types.string.String"]
    """<p>The value of the dimension detail data. Depending on the return status, this value is either the full or truncated SQL query for the following dimensions:</p> <ul> <li> <p> <code>db.query.statement</code> (Amazon DocumentDB)</p> </li> <li> <p> <code>db.sql.statement</code> (Amazon RDS and Aurora)</p> </li> </ul>"""
    dimension: NotRequired["capo_pi.types.string.String"]
    """<p>The full name of the dimension. The full name includes the group name and key name. The following values are valid:</p> <ul> <li> <p> <code>db.query.statement</code> (Amazon DocumentDB)</p> </li> <li> <p> <code>db.sql.statement</code> (Amazon RDS and Aurora)</p> </li> </ul>"""
    status: NotRequired["capo_pi.types.detail_status.DetailStatus"]
    """<p>The status of the dimension detail data. Possible values include the following:</p> <ul> <li> <p> <code>AVAILABLE</code> - The dimension detail data is ready to be retrieved.</p> </li> <li> <p> <code>PROCESSING</code> - The dimension detail data isn't ready to be retrieved because more processing time is required. If the requested detail data has the status <code>PROCESSING</code>, Performance Insights returns the truncated query.</p> </li> <li> <p> <code>UNAVAILABLE</code> - The dimension detail data could not be collected successfully.</p> </li> </ul>"""

dimension instance-attribute 

dimension: NotRequired[String]

The full name of the dimension. The full name includes the group name and key name. The following values are valid:

  • db.query.statement (Amazon DocumentDB)

  • db.sql.statement (Amazon RDS and Aurora)

status instance-attribute 

status: NotRequired[DetailStatus]

The status of the dimension detail data. Possible values include the following:

  • AVAILABLE - The dimension detail data is ready to be retrieved.

  • PROCESSING - The dimension detail data isn't ready to be retrieved because more processing time is required. If the requested detail data has the status PROCESSING, Performance Insights returns the truncated query.

  • UNAVAILABLE - The dimension detail data could not be collected successfully.

value instance-attribute 

value: NotRequired[String]

The value of the dimension detail data. Depending on the return status, this value is either the full or truncated SQL query for the following dimensions:

  • db.query.statement (Amazon DocumentDB)

  • db.sql.statement (Amazon RDS and Aurora)