AWS.Tools.CloudWatchRUM.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CloudWatchRUM</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CWRUM.AddCWRUMResourceTagCmdlet"> <summary> Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource. Currently, the only resources that can be tagged app monitors. <para> Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. </para><para> Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. </para><para> You can use the <code>TagResource</code> action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </para><para> You can associate as many as 50 tags with a resource. </para><para> For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.AddCWRUMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the CloudWatch RUM resource that you're adding tags to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.AddCWRUMResourceTagCmdlet.Tag"> <summary> <para> <para>The list of key-value pairs to associate with the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.AddCWRUMResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchRUM.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.AddCWRUMResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.AddCWRUMResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMAppMonitorCmdlet"> <summary> Retrieves the complete configuration information for one app monitor. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMAppMonitorCmdlet.Name"> <summary> <para> <para>The app monitor to retrieve information for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMAppMonitorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppMonitor'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchRUM.Model.GetAppMonitorResponse). Specifying the name of a property of type Amazon.CloudWatchRUM.Model.GetAppMonitorResponse 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="P:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMAppMonitorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMAppMonitorDataCmdlet"> <summary> Retrieves the raw performance events that RUM has collected from your web application, so that you can do your own processing or analysis of this data. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMAppMonitorDataCmdlet.TimeRange_After"> <summary> <para> <para>The beginning of the time range to retrieve performance events from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMAppMonitorDataCmdlet.TimeRange_Before"> <summary> <para> <para>The end of the time range to retrieve performance events from. If you omit this, the time range extends to the time that this operation is performed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMAppMonitorDataCmdlet.Filter"> <summary> <para> <para>An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMAppMonitorDataCmdlet.Name"> <summary> <para> <para>The name of the app monitor that collected the data that you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMAppMonitorDataCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in one operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMAppMonitorDataCmdlet.NextToken"> <summary> <para> <para>Use the token returned by the previous operation to request the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMAppMonitorDataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Events'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchRUM.Model.GetAppMonitorDataResponse). Specifying the name of a property of type Amazon.CloudWatchRUM.Model.GetAppMonitorDataResponse 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="P:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMAppMonitorDataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMAppMonitorListCmdlet"> <summary> Returns a list of the Amazon CloudWatch RUM app monitors in the account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMAppMonitorListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in one operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMAppMonitorListCmdlet.NextToken"> <summary> <para> <para>Use the token returned by the previous operation to request the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMAppMonitorListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppMonitorSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchRUM.Model.ListAppMonitorsResponse). Specifying the name of a property of type Amazon.CloudWatchRUM.Model.ListAppMonitorsResponse 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.CWRUM.GetCWRUMResourceTagCmdlet"> <summary> Displays the tags associated with a CloudWatch RUM resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource that you want to see the tags of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMResourceTagCmdlet.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.CloudWatchRUM.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.CloudWatchRUM.Model.ListTagsForResourceResponse 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="P:Amazon.PowerShell.Cmdlets.CWRUM.GetCWRUMResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWRUM.NewCWRUMAppMonitorCmdlet"> <summary> Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM. The data includes performance and reliability information such as page load time, client-side errors, and user behavior. <para> You use this operation only to create a new app monitor. To update an existing app monitor, use <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_UpdateAppMonitor.html">UpdateAppMonitor</a> instead. </para><para> After you create an app monitor, sign in to the CloudWatch RUM console to get the JavaScript code snippet to add to your web application. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-find-code-snippet.html">How do I find a code snippet that I've already generated?</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.NewCWRUMAppMonitorCmdlet.AppMonitorConfiguration_AllowCookie"> <summary> <para> <para>If you set this to <code>true</code>, the RUM web client sets two cookies, a session cookie and a user cookie. The cookies allow the RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.NewCWRUMAppMonitorCmdlet.CwLogEnabled"> <summary> <para> <para>Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.</para><para>If you omit this parameter, the default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.NewCWRUMAppMonitorCmdlet.Domain"> <summary> <para> <para>The top-level internet domain name for which your application has administrative authority.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.NewCWRUMAppMonitorCmdlet.AppMonitorConfiguration_EnableXRay"> <summary> <para> <para>If you set this to <code>true</code>, RUM enables X-Ray tracing for the user sessions that RUM samples. RUM adds an X-Ray trace header to allowed HTTP requests. It also records an X-Ray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the X-Ray console and the CloudWatch ServiceLens console. For more information, see <a href="https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html">What is X-Ray?</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.NewCWRUMAppMonitorCmdlet.AppMonitorConfiguration_ExcludedPage"> <summary> <para> <para>A list of URLs in your website or application to exclude from RUM data collection.</para><para>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.NewCWRUMAppMonitorCmdlet.AppMonitorConfiguration_FavoritePage"> <summary> <para> <para>A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.NewCWRUMAppMonitorCmdlet.AppMonitorConfiguration_GuestRoleArn"> <summary> <para> <para>The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.NewCWRUMAppMonitorCmdlet.AppMonitorConfiguration_IdentityPoolId"> <summary> <para> <para>The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.NewCWRUMAppMonitorCmdlet.AppMonitorConfiguration_IncludedPage"> <summary> <para> <para>If this app monitor is to collect data from only certain pages in your application, this structure lists those pages. </para><pre><code> <p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p> </code></pre> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.NewCWRUMAppMonitorCmdlet.Name"> <summary> <para> <para>A name for the app monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.NewCWRUMAppMonitorCmdlet.AppMonitorConfiguration_SessionSampleRate"> <summary> <para> <para>Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs.</para><para>The number you specify is the percentage of user sessions that will be used.</para><para>If you omit this parameter, the default of 10 is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.NewCWRUMAppMonitorCmdlet.Tag"> <summary> <para> <para>Assigns one or more tags (key-value pairs) to the app monitor.</para><para>Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.</para><para>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</para><pre><code> <p>You can associate as many as 50 tags with an app monitor.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p> </code></pre> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.NewCWRUMAppMonitorCmdlet.AppMonitorConfiguration_Telemetry"> <summary> <para> <para>An array that lists the types of telemetry data that this app monitor is to collect.</para><ul><li><para><code>errors</code> indicates that RUM collects data about unhandled JavaScript errors raised by your application.</para></li><li><para><code>performance</code> indicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.</para></li><li><para><code>http</code> indicates that RUM collects data about HTTP errors thrown by your application.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.NewCWRUMAppMonitorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Id'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchRUM.Model.CreateAppMonitorResponse). Specifying the name of a property of type Amazon.CloudWatchRUM.Model.CreateAppMonitorResponse 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="P:Amazon.PowerShell.Cmdlets.CWRUM.NewCWRUMAppMonitorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.NewCWRUMAppMonitorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWRUM.RemoveCWRUMAppMonitorCmdlet"> <summary> Deletes an existing app monitor. This immediately stops the collection of data. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.RemoveCWRUMAppMonitorCmdlet.Name"> <summary> <para> <para>The name of the app monitor to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.RemoveCWRUMAppMonitorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchRUM.Model.DeleteAppMonitorResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.RemoveCWRUMAppMonitorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.RemoveCWRUMAppMonitorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWRUM.RemoveCWRUMResourceTagCmdlet"> <summary> Removes one or more tags from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.RemoveCWRUMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the CloudWatch RUM resource that you're removing tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.RemoveCWRUMResourceTagCmdlet.TagKey"> <summary> <para> <para>The list of tag keys to remove from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.RemoveCWRUMResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchRUM.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.RemoveCWRUMResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.RemoveCWRUMResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWRUM.UpdateCWRUMAppMonitorCmdlet"> <summary> Updates the configuration of an existing app monitor. When you use this operation, only the parts of the app monitor configuration that you specify in this operation are changed. For any parameters that you omit, the existing values are kept. <para> You can't use this operation to change the tags of an existing app monitor. To change the tags of an existing app monitor, use <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_TagResource.html">TagResource</a>. </para><para> To create a new app monitor, use <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_CreateAppMonitor.html">CreateAppMonitor</a>. </para><para> After you update an app monitor, sign in to the CloudWatch RUM console to get the updated JavaScript code snippet to add to your web application. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-find-code-snippet.html">How do I find a code snippet that I've already generated?</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.UpdateCWRUMAppMonitorCmdlet.AppMonitorConfiguration_AllowCookie"> <summary> <para> <para>If you set this to <code>true</code>, the RUM web client sets two cookies, a session cookie and a user cookie. The cookies allow the RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.UpdateCWRUMAppMonitorCmdlet.CwLogEnabled"> <summary> <para> <para>Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.UpdateCWRUMAppMonitorCmdlet.Domain"> <summary> <para> <para>The top-level internet domain name for which your application has administrative authority.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.UpdateCWRUMAppMonitorCmdlet.AppMonitorConfiguration_EnableXRay"> <summary> <para> <para>If you set this to <code>true</code>, RUM enables X-Ray tracing for the user sessions that RUM samples. RUM adds an X-Ray trace header to allowed HTTP requests. It also records an X-Ray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the X-Ray console and the CloudWatch ServiceLens console. For more information, see <a href="https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html">What is X-Ray?</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.UpdateCWRUMAppMonitorCmdlet.AppMonitorConfiguration_ExcludedPage"> <summary> <para> <para>A list of URLs in your website or application to exclude from RUM data collection.</para><para>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.UpdateCWRUMAppMonitorCmdlet.AppMonitorConfiguration_FavoritePage"> <summary> <para> <para>A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.UpdateCWRUMAppMonitorCmdlet.AppMonitorConfiguration_GuestRoleArn"> <summary> <para> <para>The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.UpdateCWRUMAppMonitorCmdlet.AppMonitorConfiguration_IdentityPoolId"> <summary> <para> <para>The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.UpdateCWRUMAppMonitorCmdlet.AppMonitorConfiguration_IncludedPage"> <summary> <para> <para>If this app monitor is to collect data from only certain pages in your application, this structure lists those pages. </para><pre><code> <p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p> </code></pre> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.UpdateCWRUMAppMonitorCmdlet.Name"> <summary> <para> <para>The name of the app monitor to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.UpdateCWRUMAppMonitorCmdlet.AppMonitorConfiguration_SessionSampleRate"> <summary> <para> <para>Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs.</para><para>The number you specify is the percentage of user sessions that will be used.</para><para>If you omit this parameter, the default of 10 is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.UpdateCWRUMAppMonitorCmdlet.AppMonitorConfiguration_Telemetry"> <summary> <para> <para>An array that lists the types of telemetry data that this app monitor is to collect.</para><ul><li><para><code>errors</code> indicates that RUM collects data about unhandled JavaScript errors raised by your application.</para></li><li><para><code>performance</code> indicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.</para></li><li><para><code>http</code> indicates that RUM collects data about HTTP errors thrown by your application.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.UpdateCWRUMAppMonitorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchRUM.Model.UpdateAppMonitorResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.UpdateCWRUMAppMonitorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.UpdateCWRUMAppMonitorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWRUM.WriteCWRUMRumEventCmdlet"> <summary> Sends telemetry events about your application performance and user behavior to CloudWatch RUM. The code snippet that RUM generates for you to add to your application includes <code>PutRumEvents</code> operations to send this data to RUM. <para> Each <code>PutRumEvents</code> operation can send a batch of events from one user session. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.WriteCWRUMRumEventCmdlet.BatchId"> <summary> <para> <para>A unique identifier for this batch of RUM event data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.WriteCWRUMRumEventCmdlet.AppMonitorDetails_Id"> <summary> <para> <para>The unique ID of the app monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.WriteCWRUMRumEventCmdlet.Id"> <summary> <para> <para>The ID of the app monitor that is sending this data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.WriteCWRUMRumEventCmdlet.AppMonitorDetails_Name"> <summary> <para> <para>The name of the app monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.WriteCWRUMRumEventCmdlet.RumEvent"> <summary> <para> <para>An array of structures that contain the telemetry event data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.WriteCWRUMRumEventCmdlet.UserDetails_SessionId"> <summary> <para> <para>The session ID that the performance events are from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.WriteCWRUMRumEventCmdlet.UserDetails_UserId"> <summary> <para> <para>The ID of the user for this user session. This ID is generated by RUM and does not include any personally identifiable information about the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.WriteCWRUMRumEventCmdlet.AppMonitorDetails_Version"> <summary> <para> <para>The version of the app monitor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.WriteCWRUMRumEventCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchRUM.Model.PutRumEventsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.WriteCWRUMRumEventCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWRUM.WriteCWRUMRumEventCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |