AWS.Tools.XRay.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.XRay</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.XR.GetXREncryptionConfigCmdlet"> <summary> Retrieves the current encryption configuration for X-Ray data. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXREncryptionConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EncryptionConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.GetEncryptionConfigResponse). Specifying the name of a property of type Amazon.XRay.Model.GetEncryptionConfigResponse 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.XR.GetXRGroupCmdlet"> <summary> Retrieves group resource details. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRGroupCmdlet.GroupARN"> <summary> <para> <para>The ARN of the group that was generated on creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRGroupCmdlet.GroupName"> <summary> <para> <para>The case-sensitive name of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Group'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.GetGroupResponse). Specifying the name of a property of type Amazon.XRay.Model.GetGroupResponse 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.XR.GetXRGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupARN parameter. The -PassThru parameter is deprecated, use -Select '^GroupARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.XR.GetXRGroupSummaryCmdlet"> <summary> Retrieves all active group details.<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.XR.GetXRGroupSummaryCmdlet.NextToken"> <summary> <para> <para>Pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRGroupSummaryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Groups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.GetGroupsResponse). Specifying the name of a property of type Amazon.XRay.Model.GetGroupsResponse 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.XR.GetXRGroupSummaryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NextToken parameter. The -PassThru parameter is deprecated, use -Select '^NextToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRGroupSummaryCmdlet.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.XR.GetXRSamplingRuleCmdlet"> <summary> Retrieves all sampling rules.<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.XR.GetXRSamplingRuleCmdlet.NextToken"> <summary> <para> <para>Pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRSamplingRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SamplingRuleRecords'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.GetSamplingRulesResponse). Specifying the name of a property of type Amazon.XRay.Model.GetSamplingRulesResponse 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.XR.GetXRSamplingRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NextToken parameter. The -PassThru parameter is deprecated, use -Select '^NextToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRSamplingRuleCmdlet.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.XR.GetXRSamplingStatisticSummaryCmdlet"> <summary> Retrieves information about recent sampling results for all sampling rules.<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.XR.GetXRSamplingStatisticSummaryCmdlet.NextToken"> <summary> <para> <para>Pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRSamplingStatisticSummaryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SamplingStatisticSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.GetSamplingStatisticSummariesResponse). Specifying the name of a property of type Amazon.XRay.Model.GetSamplingStatisticSummariesResponse 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.XR.GetXRSamplingStatisticSummaryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NextToken parameter. The -PassThru parameter is deprecated, use -Select '^NextToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRSamplingStatisticSummaryCmdlet.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.XR.GetXRSamplingTargetCmdlet"> <summary> Requests a sampling quota for rules that the service is using to sample requests. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRSamplingTargetCmdlet.SamplingStatisticsDocument"> <summary> <para> <para>Information about rules that the service is using to sample requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRSamplingTargetCmdlet.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.XRay.Model.GetSamplingTargetsResponse). Specifying the name of a property of type Amazon.XRay.Model.GetSamplingTargetsResponse 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.XR.GetXRSamplingTargetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SamplingStatisticsDocument parameter. The -PassThru parameter is deprecated, use -Select '^SamplingStatisticsDocument' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.XR.GetXRServiceGraphCmdlet"> <summary> Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the <a href="https://docs.aws.amazon.com/xray/index.html">AWS X-Ray SDK</a>. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.<br/><br/>In the AWS.Tools.XRay module, 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.XR.GetXRServiceGraphCmdlet.EndTime"> <summary> <para> <para>The end of the timeframe for which to generate a graph.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRServiceGraphCmdlet.GroupARN"> <summary> <para> <para>The ARN of a group to generate a graph based on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRServiceGraphCmdlet.GroupName"> <summary> <para> <para>The name of a group to generate a graph based on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRServiceGraphCmdlet.StartTime"> <summary> <para> <para>The start of the time frame for which to generate a graph.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRServiceGraphCmdlet.NextToken"> <summary> <para> <para>Pagination token.</para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.XRay module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRServiceGraphCmdlet.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.XRay.Model.GetServiceGraphResponse). Specifying the name of a property of type Amazon.XRay.Model.GetServiceGraphResponse 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.XR.GetXRServiceGraphCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StartTime parameter. The -PassThru parameter is deprecated, use -Select '^StartTime' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRServiceGraphCmdlet.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.XR.GetXRTimeSeriesServiceStatisticCmdlet"> <summary> Get an aggregation of service statistics defined by a specific 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.XR.GetXRTimeSeriesServiceStatisticCmdlet.EndTime"> <summary> <para> <para>The end of the time frame for which to aggregate statistics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTimeSeriesServiceStatisticCmdlet.EntitySelectorExpression"> <summary> <para> <para>A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTimeSeriesServiceStatisticCmdlet.GroupARN"> <summary> <para> <para>The ARN of the group for which to pull statistics from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTimeSeriesServiceStatisticCmdlet.GroupName"> <summary> <para> <para>The case-sensitive name of the group for which to pull statistics from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTimeSeriesServiceStatisticCmdlet.Period"> <summary> <para> <para>Aggregation period in seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTimeSeriesServiceStatisticCmdlet.StartTime"> <summary> <para> <para>The start of the time frame for which to aggregate statistics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTimeSeriesServiceStatisticCmdlet.NextToken"> <summary> <para> <para>Pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTimeSeriesServiceStatisticCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TimeSeriesServiceStatistics'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.GetTimeSeriesServiceStatisticsResponse). Specifying the name of a property of type Amazon.XRay.Model.GetTimeSeriesServiceStatisticsResponse 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.XR.GetXRTimeSeriesServiceStatisticCmdlet.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.XR.GetXRTraceBatchCmdlet"> <summary> Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use <code>GetTraceSummaries</code> to get a list of trace IDs.<br/><br/>In the AWS.Tools.XRay module, 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.XR.GetXRTraceBatchCmdlet.TraceId"> <summary> <para> <para>Specify the trace IDs of requests for which to retrieve segments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTraceBatchCmdlet.NextToken"> <summary> <para> <para>Pagination token.</para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.XRay module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTraceBatchCmdlet.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.XRay.Model.BatchGetTracesResponse). Specifying the name of a property of type Amazon.XRay.Model.BatchGetTracesResponse 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.XR.GetXRTraceBatchCmdlet.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.XR.GetXRTraceGraphCmdlet"> <summary> Retrieves a service graph for one or more specific trace IDs.<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.XR.GetXRTraceGraphCmdlet.TraceId"> <summary> <para> <para>Trace IDs of requests for which to generate a service graph.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTraceGraphCmdlet.NextToken"> <summary> <para> <para>Pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTraceGraphCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Services'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.GetTraceGraphResponse). Specifying the name of a property of type Amazon.XRay.Model.GetTraceGraphResponse 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.XR.GetXRTraceGraphCmdlet.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.XR.GetXRTraceSummaryCmdlet"> <summary> Retrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to <code>BatchGetTraces</code>. <para> A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through <code>api.example.com</code>: </para><para><code>service("api.example.com")</code></para><para> This filter expression finds traces that have an annotation named <code>account</code> with the value <code>12345</code>: </para><para><code>annotation.account = "12345"</code></para><para> For a full list of indexed fields and keywords that you can use in filter expressions, see <a href="https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html">Using Filter Expressions</a> in the <i>AWS X-Ray Developer Guide</i>. </para><br/><br/>In the AWS.Tools.XRay module, 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.XR.GetXRTraceSummaryCmdlet.EndTime"> <summary> <para> <para>The end of the time frame for which to retrieve traces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTraceSummaryCmdlet.FilterExpression"> <summary> <para> <para>Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTraceSummaryCmdlet.SamplingStrategy_Name"> <summary> <para> <para>The name of a sampling rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTraceSummaryCmdlet.Sampling"> <summary> <para> <para>Set to <code>true</code> to get summaries for only a subset of available traces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTraceSummaryCmdlet.StartTime"> <summary> <para> <para>The start of the time frame for which to retrieve traces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTraceSummaryCmdlet.TimeRangeType"> <summary> <para> <para>A parameter to indicate whether to query trace summaries by TraceId or Event time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTraceSummaryCmdlet.SamplingStrategy_Value"> <summary> <para> <para>The value of a sampling rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTraceSummaryCmdlet.NextToken"> <summary> <para> <para>Specify the pagination token returned by a previous request to retrieve the next page of results.</para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.XRay module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTraceSummaryCmdlet.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.XRay.Model.GetTraceSummariesResponse). Specifying the name of a property of type Amazon.XRay.Model.GetTraceSummariesResponse 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.XR.GetXRTraceSummaryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StartTime parameter. The -PassThru parameter is deprecated, use -Select '^StartTime' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTraceSummaryCmdlet.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.XR.NewXRGroupCmdlet"> <summary> Creates a group resource with a name and a filter expression. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRGroupCmdlet.FilterExpression"> <summary> <para> <para>The filter expression defining criteria by which to group traces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRGroupCmdlet.GroupName"> <summary> <para> <para>The case-sensitive name of the new group. Default is a reserved name and names must be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Group'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.CreateGroupResponse). Specifying the name of a property of type Amazon.XRay.Model.CreateGroupResponse 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.XR.NewXRGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRGroupCmdlet.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.XR.NewXRSamplingRuleCmdlet"> <summary> Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with <a>GetSamplingRules</a>, and evaluate each rule in ascending order of <i>priority</i> for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with <a>GetSamplingTargets</a> to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRSamplingRuleCmdlet.SamplingRule_Attribute"> <summary> <para> <para>Matches attributes derived from the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRSamplingRuleCmdlet.SamplingRule_FixedRate"> <summary> <para> <para>The percentage of matching requests to instrument, after the reservoir is exhausted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRSamplingRuleCmdlet.SamplingRule_Host"> <summary> <para> <para>Matches the hostname from a request URL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRSamplingRuleCmdlet.SamplingRule_HTTPMethod"> <summary> <para> <para>Matches the HTTP method of a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRSamplingRuleCmdlet.SamplingRule_Priority"> <summary> <para> <para>The priority of the sampling rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRSamplingRuleCmdlet.SamplingRule_ReservoirSize"> <summary> <para> <para>A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRSamplingRuleCmdlet.SamplingRule_ResourceARN"> <summary> <para> <para>Matches the ARN of the AWS resource on which the service runs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRSamplingRuleCmdlet.SamplingRule_RuleARN"> <summary> <para> <para>The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRSamplingRuleCmdlet.SamplingRule_RuleName"> <summary> <para> <para>The name of the sampling rule. Specify a rule by either name or ARN, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRSamplingRuleCmdlet.SamplingRule_ServiceName"> <summary> <para> <para>Matches the <code>name</code> that the service uses to identify itself in segments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRSamplingRuleCmdlet.SamplingRule_ServiceType"> <summary> <para> <para>Matches the <code>origin</code> that the service uses to identify its type in segments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRSamplingRuleCmdlet.SamplingRule_URLPath"> <summary> <para> <para>Matches the path from a request URL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRSamplingRuleCmdlet.SamplingRule_Version"> <summary> <para> <para>The version of the sampling rule format (<code>1</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRSamplingRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SamplingRuleRecord'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.CreateSamplingRuleResponse). Specifying the name of a property of type Amazon.XRay.Model.CreateSamplingRuleResponse 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.XR.NewXRSamplingRuleCmdlet.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.XR.RemoveXRGroupCmdlet"> <summary> Deletes a group resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRGroupCmdlet.GroupARN"> <summary> <para> <para>The ARN of the group that was generated on creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRGroupCmdlet.GroupName"> <summary> <para> <para>The case-sensitive name of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRGroupCmdlet.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.XRay.Model.DeleteGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupARN parameter. The -PassThru parameter is deprecated, use -Select '^GroupARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRGroupCmdlet.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.XR.RemoveXRSamplingRuleCmdlet"> <summary> Deletes a sampling rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRSamplingRuleCmdlet.RuleARN"> <summary> <para> <para>The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRSamplingRuleCmdlet.RuleName"> <summary> <para> <para>The name of the sampling rule. Specify a rule by either name or ARN, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRSamplingRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SamplingRuleRecord'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.DeleteSamplingRuleResponse). Specifying the name of a property of type Amazon.XRay.Model.DeleteSamplingRuleResponse 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.XR.RemoveXRSamplingRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RuleName parameter. The -PassThru parameter is deprecated, use -Select '^RuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRSamplingRuleCmdlet.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.XR.UpdateXRGroupCmdlet"> <summary> Updates a group resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRGroupCmdlet.FilterExpression"> <summary> <para> <para>The updated filter expression defining criteria by which to group traces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRGroupCmdlet.GroupARN"> <summary> <para> <para>The ARN that was generated upon creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRGroupCmdlet.GroupName"> <summary> <para> <para>The case-sensitive name of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Group'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.UpdateGroupResponse). Specifying the name of a property of type Amazon.XRay.Model.UpdateGroupResponse 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.XR.UpdateXRGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupARN parameter. The -PassThru parameter is deprecated, use -Select '^GroupARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRGroupCmdlet.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.XR.UpdateXRSamplingRuleCmdlet"> <summary> Modifies a sampling rule's configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRSamplingRuleCmdlet.SamplingRuleUpdate_Attribute"> <summary> <para> <para>Matches attributes derived from the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRSamplingRuleCmdlet.SamplingRuleUpdate_FixedRate"> <summary> <para> <para>The percentage of matching requests to instrument, after the reservoir is exhausted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRSamplingRuleCmdlet.SamplingRuleUpdate_Host"> <summary> <para> <para>Matches the hostname from a request URL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRSamplingRuleCmdlet.SamplingRuleUpdate_HTTPMethod"> <summary> <para> <para>Matches the HTTP method of a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRSamplingRuleCmdlet.SamplingRuleUpdate_Priority"> <summary> <para> <para>The priority of the sampling rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRSamplingRuleCmdlet.SamplingRuleUpdate_ReservoirSize"> <summary> <para> <para>A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRSamplingRuleCmdlet.SamplingRuleUpdate_ResourceARN"> <summary> <para> <para>Matches the ARN of the AWS resource on which the service runs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRSamplingRuleCmdlet.SamplingRuleUpdate_RuleARN"> <summary> <para> <para>The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRSamplingRuleCmdlet.SamplingRuleUpdate_RuleName"> <summary> <para> <para>The name of the sampling rule. Specify a rule by either name or ARN, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRSamplingRuleCmdlet.SamplingRuleUpdate_ServiceName"> <summary> <para> <para>Matches the <code>name</code> that the service uses to identify itself in segments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRSamplingRuleCmdlet.SamplingRuleUpdate_ServiceType"> <summary> <para> <para>Matches the <code>origin</code> that the service uses to identify its type in segments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRSamplingRuleCmdlet.SamplingRuleUpdate_URLPath"> <summary> <para> <para>Matches the path from a request URL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRSamplingRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SamplingRuleRecord'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.UpdateSamplingRuleResponse). Specifying the name of a property of type Amazon.XRay.Model.UpdateSamplingRuleResponse 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.XR.UpdateXRSamplingRuleCmdlet.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.XR.WriteXREncryptionConfigCmdlet"> <summary> Updates the encryption configuration for X-Ray data. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXREncryptionConfigCmdlet.KeyId"> <summary> <para> <para>An AWS KMS customer master key (CMK) in one of the following formats:</para><ul><li><para><b>Alias</b> - The name of the key. For example, <code>alias/MyKey</code>.</para></li><li><para><b>Key ID</b> - The KMS key ID of the key. For example, <code>ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>. AWS X-Ray does not support asymmetric CMKs.</para></li><li><para><b>ARN</b> - The full Amazon Resource Name of the key ID or alias. For example, <code>arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>. Use this format to specify a key in a different account.</para></li></ul><para>Omit this key if you set <code>Type</code> to <code>NONE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXREncryptionConfigCmdlet.Type"> <summary> <para> <para>The type of encryption. Set to <code>KMS</code> to use your own key for encryption. Set to <code>NONE</code> for default encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXREncryptionConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EncryptionConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.PutEncryptionConfigResponse). Specifying the name of a property of type Amazon.XRay.Model.PutEncryptionConfigResponse 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.XR.WriteXREncryptionConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KeyId parameter. The -PassThru parameter is deprecated, use -Select '^KeyId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXREncryptionConfigCmdlet.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.XR.WriteXRTelemetryRecordCmdlet"> <summary> Used by the AWS X-Ray daemon to upload telemetry. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXRTelemetryRecordCmdlet.EC2InstanceId"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXRTelemetryRecordCmdlet.Hostname"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXRTelemetryRecordCmdlet.ResourceARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXRTelemetryRecordCmdlet.TelemetryRecord"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXRTelemetryRecordCmdlet.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.XRay.Model.PutTelemetryRecordsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXRTelemetryRecordCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EC2InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^EC2InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXRTelemetryRecordCmdlet.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.XR.WriteXRTraceSegmentCmdlet"> <summary> Amazon.XRay.IAmazonXRay.PutTraceSegments </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXRTraceSegmentCmdlet.TraceSegmentDocument"> <summary> <para> <para>A string containing a JSON document defining one or more segments or subsegments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXRTraceSegmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UnprocessedTraceSegments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.PutTraceSegmentsResponse). Specifying the name of a property of type Amazon.XRay.Model.PutTraceSegmentsResponse 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.XR.WriteXRTraceSegmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TraceSegmentDocument parameter. The -PassThru parameter is deprecated, use -Select '^TraceSegmentDocument' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXRTraceSegmentCmdlet.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> |