AWS.Tools.PI.dll-Help.xml
|
<helpItems schema="maml"><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-PIDimensionKey</name><description><para>Calls the AWS Performance Insights DescribeDimensionKeys API operation.</para></description><verb>Get</verb><noun>PIDimensionKey</noun><copyright><para>&copy; Copyright 2012 - 2021 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>For a specific time period, retrieve the top <code>N</code> dimension keys for a metric.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned. </para></description><syntax><syntaxItem><name>Get-PIDimensionKey</name><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>GroupBy_Dimension</name><description><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. Valid values for elements in the <code>Dimensions</code> array are: - <code>db.application.name</code> - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL) - <code>db.host.id</code> - The host ID of the connected client (all engines) - <code>db.host.name</code> - The host name of the connected client (all engines) - <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) - <code>db.session_type.name</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL) - <code>db.sql.id</code> - The SQL ID generated by Performance Insights (all engines) - <code>db.sql.db_id</code> - The SQL ID generated by the database (all engines) - <code>db.sql.statement</code> - The SQL text that is being executed (all engines) - <code>db.sql.tokenized_id</code> - <code>db.sql_tokenized.id</code> - The SQL digest ID generated by Performance Insights (all engines) - <code>db.sql_tokenized.db_id</code> - SQL digest ID generated by the database (all engines) - <code>db.sql_tokenized.statement</code> - The SQL digest text (all engines) - <code>db.user.id</code> - The ID of the user logged in to the database (all engines) - <code>db.user.name</code> - The name of the user logged in to the database (all engines) - <code>db.wait_event.name</code> - The event for which the backend is waiting (all engines) - <code>db.wait_event.type</code> - The type of event for which the backend is waiting (all engines) - <code>db.wait_event_type.name</code> - The name of the event type for which the backend is waiting (all engines) </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PartitionBy_Dimension</name><description><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. Valid values for elements in the <code>Dimensions</code> array are: - <code>db.application.name</code> - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL) - <code>db.host.id</code> - The host ID of the connected client (all engines) - <code>db.host.name</code> - The host name of the connected client (all engines) - <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) - <code>db.session_type.name</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL) - <code>db.sql.id</code> - The SQL ID generated by Performance Insights (all engines) - <code>db.sql.db_id</code> - The SQL ID generated by the database (all engines) - <code>db.sql.statement</code> - The SQL text that is being executed (all engines) - <code>db.sql.tokenized_id</code> - <code>db.sql_tokenized.id</code> - The SQL digest ID generated by Performance Insights (all engines) - <code>db.sql_tokenized.db_id</code> - SQL digest ID generated by the database (all engines) - <code>db.sql_tokenized.statement</code> - The SQL digest text (all engines) - <code>db.user.id</code> - The ID of the user logged in to the database (all engines) - <code>db.user.name</code> - The name of the user logged in to the database (all engines) - <code>db.wait_event.name</code> - The event for which the backend is waiting (all engines) - <code>db.wait_event.type</code> - The type of event for which the backend is waiting (all engines) - <code>db.wait_event_type.name</code> - The name of the event type for which the backend is waiting (all engines) </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndTime</name><description><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. The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>. </para></description><parameterValue required="true" variableLength="false">System.DateTime</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Filter</name><description><para>One or more filters to apply in the request. Restrictions: - Any number of filters by the same dimension, as specified in the <code>GroupBy</code> or <code>Partition</code> parameters. - A single filter for any other dimension in this dimension group. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>GroupBy_Group</name><description><para>The name of the dimension group. Valid values are: - <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) - <code>db.application</code> - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL) - <code>db.host</code> - The host name of the connected client (all engines) - <code>db.session_type</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL) - <code>db.sql</code> - The SQL that is currently executing (all engines) - <code>db.sql_tokenized</code> - The SQL digest (all engines) - <code>db.wait_event</code> - The event for which the database backend is waiting (all engines) - <code>db.wait_event_type</code> - The type of event for which the database backend is waiting (all engines) - <code>db.user</code> - The user logged in to the database (all engines) </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PartitionBy_Group</name><description><para>The name of the dimension group. Valid values are: - <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) - <code>db.application</code> - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL) - <code>db.host</code> - The host name of the connected client (all engines) - <code>db.session_type</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL) - <code>db.sql</code> - The SQL that is currently executing (all engines) - <code>db.sql_tokenized</code> - The SQL digest (all engines) - <code>db.wait_event</code> - The event for which the database backend is waiting (all engines) - <code>db.wait_event_type</code> - The type of event for which the database backend is waiting (all engines) - <code>db.user</code> - The user logged in to the database (all engines) </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Identifier</name><description><para>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 <code>DbiResourceId</code> value. For example, specify <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code> </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>GroupBy_Limit</name><description><para>The maximum number of items to fetch for this dimension group. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PartitionBy_Limit</name><description><para>The maximum number of items to fetch for this dimension group. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Metric</name><description><para>The name of a Performance Insights metric to be measured. Valid values for <code>Metric</code> are: - <code>db.load.avg</code> - a scaled representation of the number of active sessions for the database engine. - <code>db.sampledload.avg</code> - the raw number of active sessions for the database engine. 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></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PeriodInSecond</name><description><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: - <code>1</code> (one second) - <code>60</code> (one minute) - <code>300</code> (five minutes) - <code>3600</code> (one hour) - <code>86400</code> (twenty-four hours) 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></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ServiceType</name><description><para>The AWS service for which Performance Insights will return metrics. The only valid value for <i>ServiceType</i> is <code>RDS</code>. </para></description><parameterValue required="true" variableLength="false">Amazon.PI.ServiceType</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StartTime</name><description><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. The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>. </para></description><parameterValue required="true" variableLength="false">System.DateTime</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><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></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><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></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndTime</name><description><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. The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>. </para></description><parameterValue required="true" variableLength="false">System.DateTime</parameterValue><type><name>System.DateTime</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Filter</name><description><para>One or more filters to apply in the request. Restrictions: - Any number of filters by the same dimension, as specified in the <code>GroupBy</code> or <code>Partition</code> parameters. - A single filter for any other dimension in this dimension group. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue><type><name>System.Collections.Hashtable</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>GroupBy_Dimension</name><description><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. Valid values for elements in the <code>Dimensions</code> array are: - <code>db.application.name</code> - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL) - <code>db.host.id</code> - The host ID of the connected client (all engines) - <code>db.host.name</code> - The host name of the connected client (all engines) - <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) - <code>db.session_type.name</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL) - <code>db.sql.id</code> - The SQL ID generated by Performance Insights (all engines) - <code>db.sql.db_id</code> - The SQL ID generated by the database (all engines) - <code>db.sql.statement</code> - The SQL text that is being executed (all engines) - <code>db.sql.tokenized_id</code> - <code>db.sql_tokenized.id</code> - The SQL digest ID generated by Performance Insights (all engines) - <code>db.sql_tokenized.db_id</code> - SQL digest ID generated by the database (all engines) - <code>db.sql_tokenized.statement</code> - The SQL digest text (all engines) - <code>db.user.id</code> - The ID of the user logged in to the database (all engines) - <code>db.user.name</code> - The name of the user logged in to the database (all engines) - <code>db.wait_event.name</code> - The event for which the backend is waiting (all engines) - <code>db.wait_event.type</code> - The type of event for which the backend is waiting (all engines) - <code>db.wait_event_type.name</code> - The name of the event type for which the backend is waiting (all engines) </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>GroupBy_Group</name><description><para>The name of the dimension group. Valid values are: - <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) - <code>db.application</code> - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL) - <code>db.host</code> - The host name of the connected client (all engines) - <code>db.session_type</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL) - <code>db.sql</code> - The SQL that is currently executing (all engines) - <code>db.sql_tokenized</code> - The SQL digest (all engines) - <code>db.wait_event</code> - The event for which the database backend is waiting (all engines) - <code>db.wait_event_type</code> - The type of event for which the database backend is waiting (all engines) - <code>db.user</code> - The user logged in to the database (all engines) </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>GroupBy_Limit</name><description><para>The maximum number of items to fetch for this dimension group. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Identifier</name><description><para>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 <code>DbiResourceId</code> value. For example, specify <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code> </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><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></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Metric</name><description><para>The name of a Performance Insights metric to be measured. Valid values for <code>Metric</code> are: - <code>db.load.avg</code> - a scaled representation of the number of active sessions for the database engine. - <code>db.sampledload.avg</code> - the raw number of active sessions for the database engine. 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></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><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></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PartitionBy_Dimension</name><description><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. Valid values for elements in the <code>Dimensions</code> array are: - <code>db.application.name</code> - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL) - <code>db.host.id</code> - The host ID of the connected client (all engines) - <code>db.host.name</code> - The host name of the connected client (all engines) - <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) - <code>db.session_type.name</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL) - <code>db.sql.id</code> - The SQL ID generated by Performance Insights (all engines) - <code>db.sql.db_id</code> - The SQL ID generated by the database (all engines) - <code>db.sql.statement</code> - The SQL text that is being executed (all engines) - <code>db.sql.tokenized_id</code> - <code>db.sql_tokenized.id</code> - The SQL digest ID generated by Performance Insights (all engines) - <code>db.sql_tokenized.db_id</code> - SQL digest ID generated by the database (all engines) - <code>db.sql_tokenized.statement</code> - The SQL digest text (all engines) - <code>db.user.id</code> - The ID of the user logged in to the database (all engines) - <code>db.user.name</code> - The name of the user logged in to the database (all engines) - <code>db.wait_event.name</code> - The event for which the backend is waiting (all engines) - <code>db.wait_event.type</code> - The type of event for which the backend is waiting (all engines) - <code>db.wait_event_type.name</code> - The name of the event type for which the backend is waiting (all engines) </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PartitionBy_Group</name><description><para>The name of the dimension group. Valid values are: - <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) - <code>db.application</code> - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL) - <code>db.host</code> - The host name of the connected client (all engines) - <code>db.session_type</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL) - <code>db.sql</code> - The SQL that is currently executing (all engines) - <code>db.sql_tokenized</code> - The SQL digest (all engines) - <code>db.wait_event</code> - The event for which the database backend is waiting (all engines) - <code>db.wait_event_type</code> - The type of event for which the database backend is waiting (all engines) - <code>db.user</code> - The user logged in to the database (all engines) </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PartitionBy_Limit</name><description><para>The maximum number of items to fetch for this dimension group. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PeriodInSecond</name><description><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: - <code>1</code> (one second) - <code>60</code> (one minute) - <code>300</code> (five minutes) - <code>3600</code> (one hour) - <code>86400</code> (twenty-four hours) 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></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ServiceType</name><description><para>The AWS service for which Performance Insights will return metrics. The only valid value for <i>ServiceType</i> is <code>RDS</code>. </para></description><parameterValue required="true" variableLength="false">Amazon.PI.ServiceType</parameterValue><type><name>Amazon.PI.ServiceType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StartTime</name><description><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. The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>. </para></description><parameterValue required="true" variableLength="false">System.DateTime</parameterValue><type><name>System.DateTime</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.PI.Model.DescribeDimensionKeysResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.PI.Model.DescribeDimensionKeysResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PIDimensionKey.html&tocid=Get-PIDimensionKey</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>User Guide:</linkText><uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-PIDimensionKeyDetail</name><description><para>Calls the AWS Performance Insights GetDimensionKeyDetails API operation.</para></description><verb>Get</verb><noun>PIDimensionKeyDetail</noun><copyright><para>&copy; Copyright 2012 - 2021 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>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&#39;t support retrieval of large SQL statement text. </para></description><syntax><syntaxItem><name>Get-PIDimensionKeyDetail</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Group</name><description><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></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>GroupIdentifier</name><description><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></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Identifier</name><description><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></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RequestedDimension</name><description><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></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ServiceType</name><description><para>The AWS service for which Performance Insights returns data. The only valid value is <code>RDS</code>. </para></description><parameterValue required="true" variableLength="false">Amazon.PI.ServiceType</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Group</name><description><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></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>GroupIdentifier</name><description><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></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Identifier</name><description><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></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RequestedDimension</name><description><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></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ServiceType</name><description><para>The AWS service for which Performance Insights returns data. The only valid value is <code>RDS</code>. </para></description><parameterValue required="true" variableLength="false">Amazon.PI.ServiceType</parameterValue><type><name>Amazon.PI.ServiceType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.PI.Model.GetDimensionKeyDetailsResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.PI.Model.GetDimensionKeyDetailsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PIDimensionKeyDetail.html&tocid=Get-PIDimensionKeyDetail</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>User Guide:</linkText><uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-PIResourceMetric</name><description><para>Calls the AWS Performance Insights GetResourceMetrics API operation.</para></description><verb>Get</verb><noun>PIResourceMetric</noun><copyright><para>&copy; Copyright 2012 - 2021 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>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. Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned. </para></description><syntax><syntaxItem><name>Get-PIResourceMetric</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndTime</name><description><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. The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>. </para></description><parameterValue required="true" variableLength="false">System.DateTime</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Identifier</name><description><para>An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MetricQuery</name><description><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></description><parameterValue required="true" variableLength="false">Amazon.PI.Model.MetricQuery[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PeriodInSecond</name><description><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: - <code>1</code> (one second) - <code>60</code> (one minute) - <code>300</code> (five minutes) - <code>3600</code> (one hour) - <code>86400</code> (twenty-four hours) 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></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ServiceType</name><description><para>The AWS service for which Performance Insights returns metrics. The only valid value for <i>ServiceType</i> is <code>RDS</code>. </para></description><parameterValue required="true" variableLength="false">Amazon.PI.ServiceType</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StartTime</name><description><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. The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>. </para></description><parameterValue required="true" variableLength="false">System.DateTime</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><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></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><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></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndTime</name><description><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. The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>. </para></description><parameterValue required="true" variableLength="false">System.DateTime</parameterValue><type><name>System.DateTime</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Identifier</name><description><para>An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><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></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MetricQuery</name><description><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></description><parameterValue required="true" variableLength="false">Amazon.PI.Model.MetricQuery[]</parameterValue><type><name>Amazon.PI.Model.MetricQuery[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><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></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PeriodInSecond</name><description><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: - <code>1</code> (one second) - <code>60</code> (one minute) - <code>300</code> (five minutes) - <code>3600</code> (one hour) - <code>86400</code> (twenty-four hours) 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></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ServiceType</name><description><para>The AWS service for which Performance Insights returns metrics. The only valid value for <i>ServiceType</i> is <code>RDS</code>. </para></description><parameterValue required="true" variableLength="false">Amazon.PI.ServiceType</parameterValue><type><name>Amazon.PI.ServiceType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>StartTime</name><description><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. The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>. </para></description><parameterValue required="true" variableLength="false">System.DateTime</parameterValue><type><name>System.DateTime</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.PI.Model.GetResourceMetricsResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.PI.Model.GetResourceMetricsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PIResourceMetric.html&tocid=Get-PIResourceMetric</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>User Guide:</linkText><uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html</uri></navigationLink></relatedLinks></command></helpItems> |