AWS.Tools.PI.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.PI</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyCmdlet"> <summary> For a specific time period, retrieve the top <code>N</code> dimension keys for a metric. <note><para> Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyCmdlet.GroupBy_Dimension"> <summary> <para> <para>A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.</para><para>Valid values for elements in the <code>Dimensions</code> array are:</para><ul><li><para><code>db.application.name</code> - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)</para></li><li><para><code>db.host.id</code> - The host ID of the connected client (all engines)</para></li><li><para><code>db.host.name</code> - The host name of the connected client (all engines)</para></li><li><para><code>db.name</code> - The name of the database to which the client is connected (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, RDS MySQL, and MariaDB)</para></li><li><para><code>db.session_type.name</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)</para></li><li><para><code>db.sql.id</code> - The SQL ID generated by Performance Insights (all engines)</para></li><li><para><code>db.sql.db_id</code> - The SQL ID generated by the database (all engines)</para></li><li><para><code>db.sql.statement</code> - The SQL text that is being executed (all engines)</para></li><li><para><code>db.sql.tokenized_id</code></para></li><li><para><code>db.sql_tokenized.id</code> - The SQL digest ID generated by Performance Insights (all engines)</para></li><li><para><code>db.sql_tokenized.db_id</code> - SQL digest ID generated by the database (all engines)</para></li><li><para><code>db.sql_tokenized.statement</code> - The SQL digest text (all engines)</para></li><li><para><code>db.user.id</code> - The ID of the user logged in to the database (all engines)</para></li><li><para><code>db.user.name</code> - The name of the user logged in to the database (all engines)</para></li><li><para><code>db.wait_event.name</code> - The event for which the backend is waiting (all engines)</para></li><li><para><code>db.wait_event.type</code> - The type of event for which the backend is waiting (all engines)</para></li><li><para><code>db.wait_event_type.name</code> - The name of the event type for which the backend is waiting (all engines)</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyCmdlet.PartitionBy_Dimension"> <summary> <para> <para>A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.</para><para>Valid values for elements in the <code>Dimensions</code> array are:</para><ul><li><para><code>db.application.name</code> - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)</para></li><li><para><code>db.host.id</code> - The host ID of the connected client (all engines)</para></li><li><para><code>db.host.name</code> - The host name of the connected client (all engines)</para></li><li><para><code>db.name</code> - The name of the database to which the client is connected (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, RDS MySQL, and MariaDB)</para></li><li><para><code>db.session_type.name</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)</para></li><li><para><code>db.sql.id</code> - The SQL ID generated by Performance Insights (all engines)</para></li><li><para><code>db.sql.db_id</code> - The SQL ID generated by the database (all engines)</para></li><li><para><code>db.sql.statement</code> - The SQL text that is being executed (all engines)</para></li><li><para><code>db.sql.tokenized_id</code></para></li><li><para><code>db.sql_tokenized.id</code> - The SQL digest ID generated by Performance Insights (all engines)</para></li><li><para><code>db.sql_tokenized.db_id</code> - SQL digest ID generated by the database (all engines)</para></li><li><para><code>db.sql_tokenized.statement</code> - The SQL digest text (all engines)</para></li><li><para><code>db.user.id</code> - The ID of the user logged in to the database (all engines)</para></li><li><para><code>db.user.name</code> - The name of the user logged in to the database (all engines)</para></li><li><para><code>db.wait_event.name</code> - The event for which the backend is waiting (all engines)</para></li><li><para><code>db.wait_event.type</code> - The type of event for which the backend is waiting (all engines)</para></li><li><para><code>db.wait_event_type.name</code> - The name of the event type for which the backend is waiting (all engines)</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyCmdlet.EndTime"> <summary> <para> <para>The date and time specifying the end of the requested time series data. The value specified is <i>exclusive</i>, which means that data points less than (but not equal to) <code>EndTime</code> are returned.</para><para>The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyCmdlet.Filter"> <summary> <para> <para>One or more filters to apply in the request. Restrictions:</para><ul><li><para>Any number of filters by the same dimension, as specified in the <code>GroupBy</code> or <code>Partition</code> parameters.</para></li><li><para>A single filter for any other dimension in this dimension group.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyCmdlet.GroupBy_Group"> <summary> <para> <para>The name of the dimension group. Valid values are:</para><ul><li><para><code>db</code> - The name of the database to which the client is connected (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, RDS MySQL, and MariaDB)</para></li><li><para><code>db.application</code> - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)</para></li><li><para><code>db.host</code> - The host name of the connected client (all engines)</para></li><li><para><code>db.session_type</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)</para></li><li><para><code>db.sql</code> - The SQL that is currently executing (all engines)</para></li><li><para><code>db.sql_tokenized</code> - The SQL digest (all engines)</para></li><li><para><code>db.wait_event</code> - The event for which the database backend is waiting (all engines)</para></li><li><para><code>db.wait_event_type</code> - The type of event for which the database backend is waiting (all engines)</para></li><li><para><code>db.user</code> - The user logged in to the database (all engines)</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyCmdlet.PartitionBy_Group"> <summary> <para> <para>The name of the dimension group. Valid values are:</para><ul><li><para><code>db</code> - The name of the database to which the client is connected (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, RDS MySQL, and MariaDB)</para></li><li><para><code>db.application</code> - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)</para></li><li><para><code>db.host</code> - The host name of the connected client (all engines)</para></li><li><para><code>db.session_type</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)</para></li><li><para><code>db.sql</code> - The SQL that is currently executing (all engines)</para></li><li><para><code>db.sql_tokenized</code> - The SQL digest (all engines)</para></li><li><para><code>db.wait_event</code> - The event for which the database backend is waiting (all engines)</para></li><li><para><code>db.wait_event_type</code> - The type of event for which the database backend is waiting (all engines)</para></li><li><para><code>db.user</code> - The user logged in to the database (all engines)</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyCmdlet.Identifier"> <summary> <para> <para>An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.</para><para>To use an Amazon RDS instance as a data source, you specify its <code>DbiResourceId</code> value. For example, specify <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyCmdlet.GroupBy_Limit"> <summary> <para> <para>The maximum number of items to fetch for this dimension group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyCmdlet.PartitionBy_Limit"> <summary> <para> <para>The maximum number of items to fetch for this dimension group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyCmdlet.Metric"> <summary> <para> <para>The name of a Performance Insights metric to be measured.</para><para>Valid values for <code>Metric</code> are:</para><ul><li><para><code>db.load.avg</code> - a scaled representation of the number of active sessions for the database engine.</para></li><li><para><code>db.sampledload.avg</code> - the raw number of active sessions for the database engine.</para></li></ul><para>If the number of active sessions is less than an internal Performance Insights threshold, <code>db.load.avg</code> and <code>db.sampledload.avg</code> are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with <code>db.load.avg</code> showing the scaled values, <code>db.sampledload.avg</code> showing the raw values, and <code>db.sampledload.avg</code> less than <code>db.load.avg</code>. For most use cases, you can query <code>db.load.avg</code> only. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyCmdlet.PeriodInSecond"> <summary> <para> <para>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:</para><ul><li><para><code>1</code> (one second)</para></li><li><para><code>60</code> (one minute)</para></li><li><para><code>300</code> (five minutes)</para></li><li><para><code>3600</code> (one hour)</para></li><li><para><code>86400</code> (twenty-four hours)</para></li></ul><para>If you don't specify <code>PeriodInSeconds</code>, then Performance Insights chooses a value for you, with a goal of returning roughly 100-200 data points in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyCmdlet.ServiceType"> <summary> <para> <para>The AWS service for which Performance Insights will return metrics. The only valid value for <i>ServiceType</i> is <code>RDS</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyCmdlet.StartTime"> <summary> <para> <para>The date and time specifying the beginning of the requested time series data. You must specify a <code>StartTime</code> within the past 7 days. The value specified is <i>inclusive</i>, which means that data points equal to or greater than <code>StartTime</code> are returned.</para><para>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyCmdlet.MaxResult"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyCmdlet.NextToken"> <summary> <para> <para>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>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PI.Model.DescribeDimensionKeysResponse). Specifying the name of a property of type Amazon.PI.Model.DescribeDimensionKeysResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyDetailCmdlet"> <summary> Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, <code>GetDimensionKeyDetails</code> retrieves the full text of the dimension <code>db.sql.statement</code> associated with this ID. This operation is useful because <code>GetResourceMetrics</code> and <code>DescribeDimensionKeys</code> don't support retrieval of large SQL statement text. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyDetailCmdlet.Group"> <summary> <para> <para>The name of the dimension group. The only valid value is <code>db.sql</code>. Performance Insights searches the specified group for the dimension group ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyDetailCmdlet.GroupIdentifier"> <summary> <para> <para>The ID of the dimension group from which to retrieve dimension details. For dimension group <code>db.sql</code>, the group ID is <code>db.sql.id</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyDetailCmdlet.Identifier"> <summary> <para> <para>The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an AWS Region. When a DB instance is the data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyDetailCmdlet.RequestedDimension"> <summary> <para> <para>A list of dimensions to retrieve the detail data for within the given dimension group. For the dimension group <code>db.sql</code>, specify either the full dimension name <code>db.sql.statement</code> or the short dimension name <code>statement</code>. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyDetailCmdlet.ServiceType"> <summary> <para> <para>The AWS service for which Performance Insights returns data. The only valid value is <code>RDS</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIDimensionKeyDetailCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PI.Model.GetDimensionKeyDetailsResponse). Specifying the name of a property of type Amazon.PI.Model.GetDimensionKeyDetailsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PI.GetPIResourceMetricCmdlet"> <summary> Retrieve Performance Insights metrics for a set of data sources, over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group. <note><para> Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIResourceMetricCmdlet.EndTime"> <summary> <para> <para>The date and time specifying the end of the requested time series data. The value specified is <i>exclusive</i> - data points less than (but not equal to) <code>EndTime</code> will be returned.</para><para>The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIResourceMetricCmdlet.Identifier"> <summary> <para> <para>An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.</para><para>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIResourceMetricCmdlet.MetricQuery"> <summary> <para> <para>An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering criteria.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIResourceMetricCmdlet.PeriodInSecond"> <summary> <para> <para>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:</para><ul><li><para><code>1</code> (one second)</para></li><li><para><code>60</code> (one minute)</para></li><li><para><code>300</code> (five minutes)</para></li><li><para><code>3600</code> (one hour)</para></li><li><para><code>86400</code> (twenty-four hours)</para></li></ul><para>If you don't specify <code>PeriodInSeconds</code>, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIResourceMetricCmdlet.ServiceType"> <summary> <para> <para>The AWS service for which Performance Insights returns metrics. The only valid value for <i>ServiceType</i> is <code>RDS</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIResourceMetricCmdlet.StartTime"> <summary> <para> <para>The date and time specifying the beginning of the requested time series data. You can't specify a <code>StartTime</code> that's earlier than 7 days ago. The value specified is <i>inclusive</i> - data points equal to or greater than <code>StartTime</code> will be returned.</para><para>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIResourceMetricCmdlet.MaxResult"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIResourceMetricCmdlet.NextToken"> <summary> <para> <para>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>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PI.GetPIResourceMetricCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PI.Model.GetResourceMetricsResponse). Specifying the name of a property of type Amazon.PI.Model.GetResourceMetricsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> </members> </doc> |