AWS.Tools.CodeGuruProfiler.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CodeGuruProfiler</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CGP.AddCGPNotificationChannelCmdlet"> <summary> Add up to 2 anomaly notifications channels for a profiling group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.AddCGPNotificationChannelCmdlet.Channel"> <summary> <para> <para>One or 2 channels to report to when anomalies are detected.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.AddCGPNotificationChannelCmdlet.ProfilingGroupName"> <summary> <para> <para>The name of the profiling group that we are setting up notifications for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.AddCGPNotificationChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NotificationConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruProfiler.Model.AddNotificationChannelsResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.AddNotificationChannelsResponse 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.CGP.AddCGPNotificationChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.AddCGPNotificationChannelCmdlet.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.CGP.AddCGPResourceTagCmdlet"> <summary> Use to assign one or more tags to a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.AddCGPResourceTagCmdlet.ResourceArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the resource that the tags are added to. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.AddCGPResourceTagCmdlet.Tag"> <summary> <para> <para> The list of tags that are added to the specified resource. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.AddCGPResourceTagCmdlet.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.CodeGuruProfiler.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.AddCGPResourceTagCmdlet.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.CGP.AddCGPResourceTagCmdlet.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.CGP.GetCGPFindingsReportAccountSummaryCmdlet"> <summary> Returns a list of <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_FindingsReportSummary.html"><c>FindingsReportSummary</c></a> objects that contain analysis results for all profiling groups in your AWS account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPFindingsReportAccountSummaryCmdlet.DailyReportsOnly"> <summary> <para> <para>A <c>Boolean</c> value indicating whether to only return reports from daily profiles. If set to <c>True</c>, only analysis data from daily profiles is returned. If set to <c>False</c>, analysis data is returned from smaller time windows (for example, one hour).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPFindingsReportAccountSummaryCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results returned by <c> GetFindingsReportAccountSummary</c> in paginated output. When this parameter is used, <c>GetFindingsReportAccountSummary</c> only returns <c>maxResults</c> results in a single page along with a <c>nextToken</c> response element. The remaining results of the initial request can be seen by sending another <c>GetFindingsReportAccountSummary</c> request with the returned <c>nextToken</c> value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPFindingsReportAccountSummaryCmdlet.NextToken"> <summary> <para> <para>The <c>nextToken</c> value returned from a previous paginated <c>GetFindingsReportAccountSummary</c> request where <c>maxResults</c> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <c>nextToken</c> value. </para><note><para>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPFindingsReportAccountSummaryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReportSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruProfiler.Model.GetFindingsReportAccountSummaryResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.GetFindingsReportAccountSummaryResponse 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.CGP.GetCGPFindingsReportAccountSummaryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DailyReportsOnly parameter. The -PassThru parameter is deprecated, use -Select '^DailyReportsOnly' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPFindingsReportAccountSummaryCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGP.GetCGPFindingsReportListCmdlet"> <summary> List the available reports for a given profiling group and time range.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPFindingsReportListCmdlet.DailyReportsOnly"> <summary> <para> <para>A <c>Boolean</c> value indicating whether to only return reports from daily profiles. If set to <c>True</c>, only analysis data from daily profiles is returned. If set to <c>False</c>, analysis data is returned from smaller time windows (for example, one hour).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPFindingsReportListCmdlet.EndTime"> <summary> <para> <para> The end time of the profile to get analysis data about. You must specify <c>startTime</c> and <c>endTime</c>. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPFindingsReportListCmdlet.ProfilingGroupName"> <summary> <para> <para>The name of the profiling group from which to search for analysis data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPFindingsReportListCmdlet.StartTime"> <summary> <para> <para> The start time of the profile to get analysis data about. You must specify <c>startTime</c> and <c>endTime</c>. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPFindingsReportListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of report results returned by <c>ListFindingsReports</c> in paginated output. When this parameter is used, <c>ListFindingsReports</c> only returns <c>maxResults</c> results in a single page along with a <c>nextToken</c> response element. The remaining results of the initial request can be seen by sending another <c>ListFindingsReports</c> request with the returned <c>nextToken</c> value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPFindingsReportListCmdlet.NextToken"> <summary> <para> <para>The <c>nextToken</c> value returned from a previous paginated <c>ListFindingsReportsRequest</c> request where <c>maxResults</c> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <c>nextToken</c> value. </para><note><para>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPFindingsReportListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FindingsReportSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruProfiler.Model.ListFindingsReportsResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.ListFindingsReportsResponse 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.CGP.GetCGPFindingsReportListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPFindingsReportListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGP.GetCGPGetFrameMetricDataCmdlet"> <summary> Returns the time series of values for a requested list of frame metrics from a time period. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPGetFrameMetricDataCmdlet.EndTime"> <summary> <para> <para> The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPGetFrameMetricDataCmdlet.FrameMetric"> <summary> <para> <para> The details of the metrics that are used to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPGetFrameMetricDataCmdlet.Period"> <summary> <para> <para> The duration of the frame metrics used to return the time series values. Specify using the ISO 8601 format. The maximum period duration is one day (<c>PT24H</c> or <c>P1D</c>). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPGetFrameMetricDataCmdlet.ProfilingGroupName"> <summary> <para> <para> The name of the profiling group associated with the the frame metrics used to return the time series values. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPGetFrameMetricDataCmdlet.StartTime"> <summary> <para> <para> The start time of the time period for the frame metrics used to return the time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPGetFrameMetricDataCmdlet.TargetResolution"> <summary> <para> <para>The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. There are 3 valid values. </para><ul><li><para><c>P1D</c> — 1 day </para></li><li><para><c>PT1H</c> — 1 hour </para></li><li><para><c>PT5M</c> — 5 minutes </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPGetFrameMetricDataCmdlet.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.CodeGuruProfiler.Model.BatchGetFrameMetricDataResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.BatchGetFrameMetricDataResponse 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.CGP.GetCGPGetFrameMetricDataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGP.GetCGPNotificationConfigurationCmdlet"> <summary> Get the current configuration for anomaly notifications for a profiling group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPNotificationConfigurationCmdlet.ProfilingGroupName"> <summary> <para> <para>The name of the profiling group we want to get the notification configuration for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPNotificationConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NotificationConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruProfiler.Model.GetNotificationConfigurationResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.GetNotificationConfigurationResponse 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.CGP.GetCGPNotificationConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGP.GetCGPPolicyCmdlet"> <summary> Returns the JSON-formatted resource-based policy on a profiling group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPPolicyCmdlet.ProfilingGroupName"> <summary> <para> <para>The name of the profiling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPPolicyCmdlet.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.CodeGuruProfiler.Model.GetPolicyResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.GetPolicyResponse 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.CGP.GetCGPPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileCmdlet"> <summary> Gets the aggregated profile of a profiling group for a specified time range. Amazon CodeGuru Profiler collects posted agent profiles for a profiling group into aggregated profiles. <pre><c> <note> <p> Because aggregated profiles expire over time <code>GetProfile</code> is not idempotent. </p> </note> <p> Specify the time range for the requested aggregated profile using 1 or 2 of the following parameters: <code>startTime</code>, <code>endTime</code>, <code>period</code>. The maximum time range allowed is 7 days. If you specify all 3 parameters, an exception is thrown. If you specify only <code>period</code>, the latest aggregated profile is returned. </p> <p> Aggregated profiles are available with aggregation periods of 5 minutes, 1 hour, and 1 day, aligned to UTC. The aggregation period of an aggregated profile determines how long it is retained. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html"> <code>AggregatedProfileTime</code> </a>. The aggregated profile's aggregation period determines how long it is retained by CodeGuru Profiler. </p> <ul> <li> <p> If the aggregation period is 5 minutes, the aggregated profile is retained for 15 days. </p> </li> <li> <p> If the aggregation period is 1 hour, the aggregated profile is retained for 60 days. </p> </li> <li> <p> If the aggregation period is 1 day, the aggregated profile is retained for 3 years. </p> </li> </ul> <p>There are two use cases for calling <code>GetProfile</code>.</p> <ol> <li> <p> If you want to return an aggregated profile that already exists, use <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ListProfileTimes.html"> <code>ListProfileTimes</code> </a> to view the time ranges of existing aggregated profiles. Use them in a <code>GetProfile</code> request to return a specific, existing aggregated profile. </p> </li> <li> <p> If you want to return an aggregated profile for a time range that doesn't align with an existing aggregated profile, then CodeGuru Profiler makes a best effort to combine existing aggregated profiles from the requested time range and return them as one aggregated profile. </p> <p> If aggregated profiles do not exist for the full time range requested, then aggregated profiles for a smaller time range are returned. For example, if the requested time range is from 00:00 to 00:20, and the existing aggregated profiles are from 00:15 and 00:25, then the aggregated profiles from 00:15 to 00:20 are returned. </p> </li> </ol> </c></pre> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileCmdlet.Accept"> <summary> <para> <para> The format of the returned profiling data. The format maps to the <c>Accept</c> and <c>Content-Type</c> headers of the HTTP request. You can specify one of the following: or the default . </para><pre><c> <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul> </c></pre> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileCmdlet.EndTime"> <summary> <para> <para> The end time of the requested profile. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </para><para> If you specify <c>endTime</c>, then you must also specify <c>period</c> or <c>startTime</c>, but not both. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileCmdlet.MaxDepth"> <summary> <para> <para> The maximum depth of the stacks in the code that is represented in the aggregated profile. For example, if CodeGuru Profiler finds a method <c>A</c>, which calls method <c>B</c>, which calls method <c>C</c>, which calls method <c>D</c>, then the depth is 4. If the <c>maxDepth</c> is set to 2, then the aggregated profile contains representations of methods <c>A</c> and <c>B</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileCmdlet.Period"> <summary> <para> <para> Used with <c>startTime</c> or <c>endTime</c> to specify the time range for the returned aggregated profile. Specify using the ISO 8601 format. For example, <c>P1DT1H1M1S</c>. </para><pre><c> <p> To get the latest aggregated profile, specify only <code>period</code>. </p> </c></pre> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileCmdlet.ProfilingGroupName"> <summary> <para> <para>The name of the profiling group to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileCmdlet.StartTime"> <summary> <para> <para>The start time of the profile to get. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</para><pre><c> <p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p> </c></pre> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileCmdlet.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.CodeGuruProfiler.Model.GetProfileResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.GetProfileResponse 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.CGP.GetCGPProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileTimeListCmdlet"> <summary> Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileTimeListCmdlet.EndTime"> <summary> <para> <para>The end time of the time range from which to list the profiles.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileTimeListCmdlet.OrderBy"> <summary> <para> <para>The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to <c>TIMESTAMP_DESCENDING</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileTimeListCmdlet.Period"> <summary> <para> <para> The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. There are 3 valid values. </para><ul><li><para><c>P1D</c> — 1 day </para></li><li><para><c>PT1H</c> — 1 hour </para></li><li><para><c>PT5M</c> — 5 minutes </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileTimeListCmdlet.ProfilingGroupName"> <summary> <para> <para>The name of the profiling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileTimeListCmdlet.StartTime"> <summary> <para> <para>The start time of the time range from which to list the profiles.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileTimeListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of profile time results returned by <c>ListProfileTimes</c> in paginated output. When this parameter is used, <c>ListProfileTimes</c> only returns <c>maxResults</c> results in a single page with a <c>nextToken</c> response element. The remaining results of the initial request can be seen by sending another <c>ListProfileTimes</c> request with the returned <c>nextToken</c> value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileTimeListCmdlet.NextToken"> <summary> <para> <para>The <c>nextToken</c> value returned from a previous paginated <c>ListProfileTimes</c> request where <c>maxResults</c> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <c>nextToken</c> value. </para><note><para>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileTimeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProfileTimes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruProfiler.Model.ListProfileTimesResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.ListProfileTimesResponse 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.CGP.GetCGPProfileTimeListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfileTimeListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfilingGroupCmdlet"> <summary> Returns a <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html"><c>ProfilingGroupDescription</c></a> object that contains information about the requested profiling group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfilingGroupCmdlet.ProfilingGroupName"> <summary> <para> <para> The name of the profiling group to get information about. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfilingGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProfilingGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruProfiler.Model.DescribeProfilingGroupResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.DescribeProfilingGroupResponse 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.CGP.GetCGPProfilingGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfilingGroupListCmdlet"> <summary> Returns a list of profiling groups. The profiling groups are returned as <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html"><c>ProfilingGroupDescription</c></a> objects.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfilingGroupListCmdlet.IncludeDescription"> <summary> <para> <para>A <c>Boolean</c> value indicating whether to include a description. If <c>true</c>, then a list of <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html"><c>ProfilingGroupDescription</c></a> objects that contain detailed information about profiling groups is returned. If <c>false</c>, then a list of profiling group names is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfilingGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of profiling groups results returned by <c>ListProfilingGroups</c> in paginated output. When this parameter is used, <c>ListProfilingGroups</c> only returns <c>maxResults</c> results in a single page along with a <c>nextToken</c> response element. The remaining results of the initial request can be seen by sending another <c>ListProfilingGroups</c> request with the returned <c>nextToken</c> value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfilingGroupListCmdlet.NextToken"> <summary> <para> <para>The <c>nextToken</c> value returned from a previous paginated <c>ListProfilingGroups</c> request where <c>maxResults</c> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <c>nextToken</c> value. </para><note><para>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfilingGroupListCmdlet.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.CodeGuruProfiler.Model.ListProfilingGroupsResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.ListProfilingGroupsResponse 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.CGP.GetCGPProfilingGroupListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IncludeDescription parameter. The -PassThru parameter is deprecated, use -Select '^IncludeDescription' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPProfilingGroupListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGP.GetCGPRecommendationCmdlet"> <summary> Returns a list of <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_Recommendation.html"><c>Recommendation</c></a> objects that contain recommendations for a profiling group for a given time period. A list of <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_Anomaly.html"><c>Anomaly</c></a> objects that contains details about anomalies detected in the profiling group for the same time period is also returned. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPRecommendationCmdlet.EndTime"> <summary> <para> <para> The start time of the profile to get analysis data about. You must specify <c>startTime</c> and <c>endTime</c>. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPRecommendationCmdlet.Locale"> <summary> <para> <para> The language used to provide analysis. Specify using a string that is one of the following <c>BCP 47</c> language codes. </para><ul><li><para><c>de-DE</c> - German, Germany </para></li><li><para><c>en-GB</c> - English, United Kingdom </para></li><li><para><c>en-US</c> - English, United States </para></li><li><para><c>es-ES</c> - Spanish, Spain </para></li><li><para><c>fr-FR</c> - French, France </para></li><li><para><c>it-IT</c> - Italian, Italy </para></li><li><para><c>ja-JP</c> - Japanese, Japan </para></li><li><para><c>ko-KR</c> - Korean, Republic of Korea </para></li><li><para><c>pt-BR</c> - Portugese, Brazil </para></li><li><para><c>zh-CN</c> - Chinese, China </para></li><li><para><c>zh-TW</c> - Chinese, Taiwan </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPRecommendationCmdlet.ProfilingGroupName"> <summary> <para> <para> The name of the profiling group to get analysis data about. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPRecommendationCmdlet.StartTime"> <summary> <para> <para> The end time of the profile to get analysis data about. You must specify <c>startTime</c> and <c>endTime</c>. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPRecommendationCmdlet.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.CodeGuruProfiler.Model.GetRecommendationsResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.GetRecommendationsResponse 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.CGP.GetCGPRecommendationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGP.GetCGPResourceTagCmdlet"> <summary> Returns a list of the tags that are assigned to a specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPResourceTagCmdlet.ResourceArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the resource that contains the tags to return. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.GetCGPResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruProfiler.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.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.CGP.GetCGPResourceTagCmdlet.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.CGP.NewCGPProfilingGroupCmdlet"> <summary> Creates a profiling group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.NewCGPProfilingGroupCmdlet.ComputePlatform"> <summary> <para> <para> The compute platform of the profiling group. Use <c>AWSLambda</c> if your application runs on AWS Lambda. Use <c>Default</c> if your application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. If not specified, <c>Default</c> is used. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.NewCGPProfilingGroupCmdlet.AgentOrchestrationConfig_ProfilingEnabled"> <summary> <para> <para> A <c>Boolean</c> that specifies whether the profiling agent collects profiling data or not. Set to <c>true</c> to enable profiling. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.NewCGPProfilingGroupCmdlet.ProfilingGroupName"> <summary> <para> <para>The name of the profiling group to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.NewCGPProfilingGroupCmdlet.Tag"> <summary> <para> <para> A list of tags to add to the created profiling group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.NewCGPProfilingGroupCmdlet.ClientToken"> <summary> <para> <para> Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental creation of duplicate profiling groups if there are failures and retries. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.NewCGPProfilingGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProfilingGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruProfiler.Model.CreateProfilingGroupResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.CreateProfilingGroupResponse 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.CGP.NewCGPProfilingGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.NewCGPProfilingGroupCmdlet.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.CGP.RemoveCGPNotificationChannelCmdlet"> <summary> Remove one anomaly notifications channel for a profiling group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.RemoveCGPNotificationChannelCmdlet.ChannelId"> <summary> <para> <para>The id of the channel that we want to stop receiving notifications.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.RemoveCGPNotificationChannelCmdlet.ProfilingGroupName"> <summary> <para> <para>The name of the profiling group we want to change notification configuration for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.RemoveCGPNotificationChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NotificationConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruProfiler.Model.RemoveNotificationChannelResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.RemoveNotificationChannelResponse 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.CGP.RemoveCGPNotificationChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.RemoveCGPNotificationChannelCmdlet.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.CGP.RemoveCGPPermissionCmdlet"> <summary> Removes permissions from a profiling group's resource-based policy that are provided using an action group. The one supported action group that can be removed is <c>agentPermission</c> which grants <c>ConfigureAgent</c> and <c>PostAgent</c> permissions. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html">Resource-based policies in CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>, <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html"><c>ConfigureAgent</c></a>, and <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html"><c>PostAgentProfile</c></a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.RemoveCGPPermissionCmdlet.ActionGroup"> <summary> <para> <para> Specifies an action group that contains the permissions to remove from a profiling group's resource-based policy. One action group is supported, <c>agentPermissions</c>, which grants <c>ConfigureAgent</c> and <c>PostAgentProfile</c> permissions. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.RemoveCGPPermissionCmdlet.ProfilingGroupName"> <summary> <para> <para>The name of the profiling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.RemoveCGPPermissionCmdlet.RevisionId"> <summary> <para> <para> A universally unique identifier (UUID) for the revision of the resource-based policy from which you want to remove permissions. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.RemoveCGPPermissionCmdlet.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.CodeGuruProfiler.Model.RemovePermissionResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.RemovePermissionResponse 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.CGP.RemoveCGPPermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.RemoveCGPPermissionCmdlet.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.CGP.RemoveCGPProfilingGroupCmdlet"> <summary> Deletes a profiling group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.RemoveCGPProfilingGroupCmdlet.ProfilingGroupName"> <summary> <para> <para>The name of the profiling group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.RemoveCGPProfilingGroupCmdlet.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.CodeGuruProfiler.Model.DeleteProfilingGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.RemoveCGPProfilingGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.RemoveCGPProfilingGroupCmdlet.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.CGP.RemoveCGPResourceTagCmdlet"> <summary> Use to remove one or more tags from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.RemoveCGPResourceTagCmdlet.ResourceArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the resource that contains the tags to remove. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.RemoveCGPResourceTagCmdlet.TagKey"> <summary> <para> <para> A list of tag keys. Existing tags of resources with keys in this list are removed from the specified resource. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.RemoveCGPResourceTagCmdlet.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.CodeGuruProfiler.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.RemoveCGPResourceTagCmdlet.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.CGP.RemoveCGPResourceTagCmdlet.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.CGP.SendCGPAgentProfileCmdlet"> <summary> Submits profiling data to an aggregated profile of a profiling group. To get an aggregated profile that is created with this profiling data, use <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_GetProfile.html"><c>GetProfile</c></a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SendCGPAgentProfileCmdlet.AgentProfile"> <summary> <para> <para> The submitted profiling data. </para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SendCGPAgentProfileCmdlet.ContentType"> <summary> <para> <para> The format of the submitted profiling data. The format maps to the <c>Accept</c> and <c>Content-Type</c> headers of the HTTP request. You can specify one of the following: or the default . </para><pre><c> <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul> </c></pre> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SendCGPAgentProfileCmdlet.ProfileToken"> <summary> <para> <para> Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental submission of duplicate profiling data if there are failures and retries. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SendCGPAgentProfileCmdlet.ProfilingGroupName"> <summary> <para> <para> The name of the profiling group with the aggregated profile that receives the submitted profiling data. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SendCGPAgentProfileCmdlet.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.CodeGuruProfiler.Model.PostAgentProfileResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SendCGPAgentProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentProfile parameter. The -PassThru parameter is deprecated, use -Select '^AgentProfile' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SendCGPAgentProfileCmdlet.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.CGP.SetCGPAgentConfigurationCmdlet"> <summary> Used by profiler agents to report their current state and to receive remote configuration updates. For example, <c>ConfigureAgent</c> can be used to tell an agent whether to profile or not and for how long to return profiling data. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SetCGPAgentConfigurationCmdlet.FleetInstanceId"> <summary> <para> <para> A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container's task ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SetCGPAgentConfigurationCmdlet.Metadata"> <summary> <para> <para> Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:</para><ul><li><para><c>COMPUTE_PLATFORM</c> - The compute platform on which the agent is running </para></li><li><para><c>AGENT_ID</c> - The ID for an agent instance. </para></li><li><para><c>AWS_REQUEST_ID</c> - The AWS request ID of a Lambda invocation. </para></li><li><para><c>EXECUTION_ENVIRONMENT</c> - The execution environment a Lambda function is running on. </para></li><li><para><c>LAMBDA_FUNCTION_ARN</c> - The Amazon Resource Name (ARN) that is used to invoke a Lambda function. </para></li><li><para><c>LAMBDA_MEMORY_LIMIT_IN_MB</c> - The memory allocated to a Lambda function. </para></li><li><para><c>LAMBDA_REMAINING_TIME_IN_MILLISECONDS</c> - The time in milliseconds before execution of a Lambda function times out. </para></li><li><para><c>LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS</c> - The time in milliseconds between two invocations of a Lambda function. </para></li><li><para><c>LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS</c> - The time in milliseconds for the previous Lambda invocation. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SetCGPAgentConfigurationCmdlet.ProfilingGroupName"> <summary> <para> <para> The name of the profiling group for which the configured agent is collecting profiling data. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SetCGPAgentConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Configuration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruProfiler.Model.ConfigureAgentResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.ConfigureAgentResponse 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.CGP.SetCGPAgentConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SetCGPAgentConfigurationCmdlet.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.CGP.SubmitCGPFeedbackCmdlet"> <summary> Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SubmitCGPFeedbackCmdlet.AnomalyInstanceId"> <summary> <para> <para>The universally unique identifier (UUID) of the <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AnomalyInstance.html"><c>AnomalyInstance</c></a> object that is included in the analysis data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SubmitCGPFeedbackCmdlet.Comment"> <summary> <para> <para>Optional feedback about this anomaly.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SubmitCGPFeedbackCmdlet.ProfilingGroupName"> <summary> <para> <para>The name of the profiling group that is associated with the analysis data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SubmitCGPFeedbackCmdlet.Type"> <summary> <para> <para> The feedback tpye. Thee are two valid values, <c>Positive</c> and <c>Negative</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SubmitCGPFeedbackCmdlet.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.CodeGuruProfiler.Model.SubmitFeedbackResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SubmitCGPFeedbackCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.SubmitCGPFeedbackCmdlet.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.CGP.UpdateCGPProfilingGroupCmdlet"> <summary> Updates a profiling group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.UpdateCGPProfilingGroupCmdlet.AgentOrchestrationConfig_ProfilingEnabled"> <summary> <para> <para> A <c>Boolean</c> that specifies whether the profiling agent collects profiling data or not. Set to <c>true</c> to enable profiling. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.UpdateCGPProfilingGroupCmdlet.ProfilingGroupName"> <summary> <para> <para>The name of the profiling group to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.UpdateCGPProfilingGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProfilingGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruProfiler.Model.UpdateProfilingGroupResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.UpdateProfilingGroupResponse 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.CGP.UpdateCGPProfilingGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.UpdateCGPProfilingGroupCmdlet.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.CGP.WriteCGPPermissionCmdlet"> <summary> Adds permissions to a profiling group's resource-based policy that are provided using an action group. If a profiling group doesn't have a resource-based policy, one is created for it using the permissions in the action group and the roles and users in the <c>principals</c> parameter. <pre><c> <p> The one supported action group that can be added is <code>agentPermission</code> which grants <code>ConfigureAgent</code> and <code>PostAgent</code> permissions. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html">Resource-based policies in CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>, <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html"> <code>ConfigureAgent</code> </a>, and <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html"> <code>PostAgentProfile</code> </a>. </p> <p> The first time you call <code>PutPermission</code> on a profiling group, do not specify a <code>revisionId</code> because it doesn't have a resource-based policy. Subsequent calls must provide a <code>revisionId</code> to specify which revision of the resource-based policy to add the permissions to. </p> <p> The response contains the profiling group's JSON-formatted resource policy. </p> </c></pre> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.WriteCGPPermissionCmdlet.ActionGroup"> <summary> <para> <para> Specifies an action group that contains permissions to add to a profiling group resource. One action group is supported, <c>agentPermissions</c>, which grants permission to perform actions required by the profiling agent, <c>ConfigureAgent</c> and <c>PostAgentProfile</c> permissions. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.WriteCGPPermissionCmdlet.Principal"> <summary> <para> <para> A list ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not are supported in the ARNs. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.WriteCGPPermissionCmdlet.ProfilingGroupName"> <summary> <para> <para>The name of the profiling group to grant access to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.WriteCGPPermissionCmdlet.RevisionId"> <summary> <para> <para> A universally unique identifier (UUID) for the revision of the policy you are adding to the profiling group. Do not specify this when you add permissions to a profiling group for the first time. If a policy already exists on the profiling group, you must specify the <c>revisionId</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.WriteCGPPermissionCmdlet.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.CodeGuruProfiler.Model.PutPermissionResponse). Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.PutPermissionResponse 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.CGP.WriteCGPPermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGP.WriteCGPPermissionCmdlet.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> |