AWS.Tools.XRay.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.XRay</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.XR.AddXRResourceTagCmdlet"> <summary> Applies tags to an existing Amazon Web Services X-Ray group or sampling rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.AddXRResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.AddXRResourceTagCmdlet.Tag"> <summary> <para> <para>A map that contains one or more tag keys and tag values to attach to an X-Ray group or sampling rule. For more information about ways to use tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</para><para>The following restrictions apply to tags:</para><ul><li><para>Maximum number of user-applied tags per resource: 50</para></li><li><para>Maximum tag key length: 128 Unicode characters</para></li><li><para>Maximum tag value length: 256 Unicode characters</para></li><li><para>Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @</para></li><li><para>Tag keys and values are case sensitive.</para></li><li><para>Don't use <c>aws:</c> as a prefix for keys; it's reserved for Amazon Web Services use. You cannot edit or delete system tags.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.AddXRResourceTagCmdlet.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.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.AddXRResourceTagCmdlet.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.XR.AddXRResourceTagCmdlet.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.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/>'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.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.GetXRIndexingRuleCmdlet"> <summary> Retrieves all indexing rules. <para> Indexing rules are used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html">Transaction Search</a>. </para><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.GetXRIndexingRuleCmdlet.NextToken"> <summary> <para> <para> Specify the pagination token returned by a previous request to retrieve the next page of indexes. </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/>'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.XR.GetXRIndexingRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IndexingRules'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.GetIndexingRulesResponse). Specifying the name of a property of type Amazon.XRay.Model.GetIndexingRulesResponse 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.GetXRIndexingRuleCmdlet.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.GetXRInsightCmdlet"> <summary> Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRInsightCmdlet.InsightId"> <summary> <para> <para>The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRInsightCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Insight'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.GetInsightResponse). Specifying the name of a property of type Amazon.XRay.Model.GetInsightResponse 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.GetXRInsightCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InsightId parameter. The -PassThru parameter is deprecated, use -Select '^InsightId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.XR.GetXRInsightEventCmdlet"> <summary> X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.<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.GetXRInsightEventCmdlet.InsightId"> <summary> <para> <para>The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRInsightEventCmdlet.MaxResult"> <summary> <para> <para>Used to retrieve at most the specified value of events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRInsightEventCmdlet.NextToken"> <summary> <para> <para>Specify the pagination token returned by a previous request to retrieve the next page of events. </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/>'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.XR.GetXRInsightEventCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InsightEvents'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.GetInsightEventsResponse). Specifying the name of a property of type Amazon.XRay.Model.GetInsightEventsResponse 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.GetXRInsightEventCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InsightId parameter. The -PassThru parameter is deprecated, use -Select '^InsightId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRInsightEventCmdlet.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.GetXRInsightImpactGraphCmdlet"> <summary> Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.<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.GetXRInsightImpactGraphCmdlet.EndTime"> <summary> <para> <para>The estimated end time of the insight, in Unix time seconds. The EndTime is exclusive of the value provided. The time range between the start time and end time can't be more than six hours. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRInsightImpactGraphCmdlet.InsightId"> <summary> <para> <para>The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRInsightImpactGraphCmdlet.StartTime"> <summary> <para> <para>The estimated start time of the insight, in Unix time seconds. The StartTime is inclusive of the value provided and can't be more than 30 days old.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRInsightImpactGraphCmdlet.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> 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.XR.GetXRInsightImpactGraphCmdlet.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.GetInsightImpactGraphResponse). Specifying the name of a property of type Amazon.XRay.Model.GetInsightImpactGraphResponse 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.GetXRInsightImpactGraphCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InsightId parameter. The -PassThru parameter is deprecated, use -Select '^InsightId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRInsightImpactGraphCmdlet.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.GetXRInsightSummaryCmdlet"> <summary> Retrieves the summaries of all insights in the specified group matching the provided filter values.<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.GetXRInsightSummaryCmdlet.EndTime"> <summary> <para> <para>The end of the time frame in which the insights ended. The end time can't be more than 30 days old.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRInsightSummaryCmdlet.GroupARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRInsightSummaryCmdlet.GroupName"> <summary> <para> <para>The name of the group. Required if the GroupARN isn't provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRInsightSummaryCmdlet.StartTime"> <summary> <para> <para>The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRInsightSummaryCmdlet.State"> <summary> <para> <para>The list of insight states. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRInsightSummaryCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to display.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRInsightSummaryCmdlet.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/>'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.XR.GetXRInsightSummaryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InsightSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.GetInsightSummariesResponse). Specifying the name of a property of type Amazon.XRay.Model.GetInsightSummariesResponse 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.GetXRInsightSummaryCmdlet.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.GetXRInsightSummaryCmdlet.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.GetXRResourcePolicyListCmdlet"> <summary> Returns the list of resource policies in the target Amazon Web Services 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.XR.GetXRResourcePolicyListCmdlet.NextToken"> <summary> <para> <para>Not currently supported.</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/>'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.XR.GetXRResourcePolicyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourcePolicies'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.ListResourcePoliciesResponse). Specifying the name of a property of type Amazon.XRay.Model.ListResourcePoliciesResponse 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.GetXRResourcePolicyListCmdlet.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.GetXRResourceTagCmdlet"> <summary> Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.<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.GetXRResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRResourceTagCmdlet.NextToken"> <summary> <para> <para>A pagination token. If multiple pages of results are returned, use the <c>NextToken</c> value returned with the current page of results as the value of this parameter to get the next page of results.</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/>'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.XR.GetXRResourceTagCmdlet.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.XRay.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.XRay.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.XR.GetXRResourceTagCmdlet.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.XR.GetXRResourceTagCmdlet.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.GetXRRetrievedTraceListCmdlet"> <summary> Retrieves a list of traces for a given <c>RetrievalToken</c> from the CloudWatch log group generated by Transaction Search. For information on what each trace returns, see <a href="https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html">BatchGetTraces</a>. <para> This API does not initiate a retrieval job. To start a trace retrieval, use <c>StartTraceRetrieval</c>, which generates the required <c>RetrievalToken</c>. </para><para> When the <c>RetrievalStatus</c> is not <i>COMPLETE</i>, the API will return an empty response. Retry the request once the retrieval has completed to access the full list of traces. </para><para> For cross-account observability, this API can retrieve traces from linked accounts when CloudWatch log is the destination across relevant accounts. For more details, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>. </para><para> For retrieving data from X-Ray directly as opposed to the Transaction-Search Log group, see <a href="https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html">BatchGetTraces</a>. </para><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.GetXRRetrievedTraceListCmdlet.RetrievalToken"> <summary> <para> <para> Retrieval token. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRRetrievedTraceListCmdlet.TraceFormat"> <summary> <para> <para> Format of the requested traces. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRRetrievedTraceListCmdlet.NextToken"> <summary> <para> <para> Specify the pagination token returned by a previous request to retrieve the next page of indexes. </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/>'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.XR.GetXRRetrievedTraceListCmdlet.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.ListRetrievedTracesResponse). Specifying the name of a property of type Amazon.XRay.Model.ListRetrievedTracesResponse 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.GetXRRetrievedTraceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RetrievalToken parameter. The -PassThru parameter is deprecated, use -Select '^RetrievalToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRRetrievedTraceListCmdlet.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.GetXRRetrievedTracesGraphCmdlet"> <summary> Retrieves a service graph for traces based on the specified <c>RetrievalToken</c> from the CloudWatch log group generated by Transaction Search. This API does not initiate a retrieval job. You must first execute <c>StartTraceRetrieval</c> to obtain the required <c>RetrievalToken</c>. <para> The trace graph describes services that process incoming requests and any downstream services they call, which may include Amazon Web Services resources, external APIs, or databases. </para><para> The response is empty until the <c>RetrievalStatus</c> is <i>COMPLETE</i>. Retry the request after the status changes from <i>RUNNING</i> or <i>SCHEDULED</i> to <i>COMPLETE</i> to access the full service graph. </para><para> When CloudWatch log is the destination, this API can support cross-account observability and service graph retrieval across linked accounts. </para><para> For retrieving graphs from X-Ray directly as opposed to the Transaction-Search Log group, see <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetTraceGraph.html">GetTraceGraph</a>. </para><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.GetXRRetrievedTracesGraphCmdlet.RetrievalToken"> <summary> <para> <para> Retrieval token. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRRetrievedTracesGraphCmdlet.NextToken"> <summary> <para> <para> Specify the pagination token returned by a previous request to retrieve the next page of indexes. </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/>'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.XR.GetXRRetrievedTracesGraphCmdlet.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.GetRetrievedTracesGraphResponse). Specifying the name of a property of type Amazon.XRay.Model.GetRetrievedTracesGraphResponse 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.GetXRRetrievedTracesGraphCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RetrievalToken parameter. The -PassThru parameter is deprecated, use -Select '^RetrievalToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRRetrievedTracesGraphCmdlet.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/>'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.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/>'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.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">Amazon Web Services X-Ray SDK</a>. Downstream services can be other applications, Amazon Web Services 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 Amazon Resource Name (ARN) of a group based on which you want to generate a graph.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRServiceGraphCmdlet.GroupName"> <summary> <para> <para>The name of a group based on which you want to generate a graph.</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/>'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.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.ForecastStatistic"> <summary> <para> <para>The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTimeSeriesServiceStatisticCmdlet.GroupARN"> <summary> <para> <para>The Amazon Resource Name (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/>'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.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> <note><para> You cannot find traces through this API if Transaction Search is enabled since trace is not indexed in X-Ray. </para></note><para> Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use <c>GetTraceSummaries</c> to get a list of trace IDs. </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.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/>'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.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/>'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.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.GetXRTraceSegmentDestinationCmdlet"> <summary> Retrieves the current destination of data sent to <c>PutTraceSegments</c> and <i>OpenTelemetry</i> API. The Transaction Search feature requires a CloudWatchLogs destination. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html">Transaction Search</a> and <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-OpenTelemetry-Sections.html">OpenTelemetry</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.GetXRTraceSegmentDestinationCmdlet.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.GetTraceSegmentDestinationResponse). Specifying the name of a property of type Amazon.XRay.Model.GetTraceSegmentDestinationResponse 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.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 <c>BatchGetTraces</c>. <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 <c>api.example.com</c>: </para><para><c>service("api.example.com")</c></para><para> This filter expression finds traces that have an annotation named <c>account</c> with the value <c>12345</c>: </para><para><c>annotation.account = "12345"</c></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/aws-xray-interface-console.html#xray-console-filters">Use filter expressions</a> in the <i>Amazon Web Services 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 <c>true</c> 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>Query trace summaries by TraceId (trace start time), Event (trace update time), or Service (trace segment end 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/>'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.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.InsightsConfiguration_InsightsEnabled"> <summary> <para> <para>Set the InsightsEnabled value to true to enable insights or false to disable insights.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRGroupCmdlet.InsightsConfiguration_NotificationsEnabled"> <summary> <para> <para>Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRGroupCmdlet.Tag"> <summary> <para> <para>A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</para><para>The following restrictions apply to tags:</para><ul><li><para>Maximum number of user-applied tags per resource: 50</para></li><li><para>Maximum tag key length: 128 Unicode characters</para></li><li><para>Maximum tag value length: 256 Unicode characters</para></li><li><para>Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @</para></li><li><para>Tag keys and values are case sensitive.</para></li><li><para>Don't use <c>aws:</c> as a prefix for keys; it's reserved for Amazon Web Services use.</para></li></ul> </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 href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html">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 href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html">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 Amazon Web Services 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 <c>name</c> 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 <c>origin</c> that the service uses to identify its type in segments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.NewXRSamplingRuleCmdlet.Tag"> <summary> <para> <para>A map that contains one or more tag keys and tag values to attach to an X-Ray sampling rule. For more information about ways to use tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</para><para>The following restrictions apply to tags:</para><ul><li><para>Maximum number of user-applied tags per resource: 50</para></li><li><para>Maximum tag key length: 128 Unicode characters</para></li><li><para>Maximum tag value length: 256 Unicode characters</para></li><li><para>Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @</para></li><li><para>Tag keys and values are case sensitive.</para></li><li><para>Don't use <c>aws:</c> as a prefix for keys; it's reserved for Amazon Web Services use.</para></li></ul> </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 (<c>1</c>).</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.RemoveXRResourcePolicyCmdlet"> <summary> Deletes a resource policy from the target Amazon Web Services account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRResourcePolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the resource policy to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRResourcePolicyCmdlet.PolicyRevisionId"> <summary> <para> <para>Specifies a specific policy revision to delete. Provide a <c>PolicyRevisionId</c> to ensure an atomic delete operation. If the provided revision id does not match the latest policy revision id, an <c>InvalidPolicyRevisionIdException</c> exception is returned. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRResourcePolicyCmdlet.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.DeleteResourcePolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRResourcePolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyName parameter. The -PassThru parameter is deprecated, use -Select '^PolicyName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRResourcePolicyCmdlet.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.RemoveXRResourceTagCmdlet"> <summary> Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an <c>aws:</c> prefix). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRResourceTagCmdlet.TagKey"> <summary> <para> <para>Keys for one or more tags that you want to remove from an X-Ray group or sampling rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRResourceTagCmdlet.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.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.RemoveXRResourceTagCmdlet.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.XR.RemoveXRResourceTagCmdlet.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.StartXRTraceRetrievalCmdlet"> <summary> Initiates a trace retrieval process using the specified time range and for the give trace IDs on Transaction Search generated by the CloudWatch log group. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html">Transaction Search</a>. <para> API returns a <c>RetrievalToken</c>, which can be used with <c>ListRetrievedTraces</c> or <c>GetRetrievedTracesGraph</c> to fetch results. Retrievals will time out after 60 minutes. To execute long time ranges, consider segmenting into multiple retrievals. </para><para> If you are using <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>, you can use this operation in a monitoring account to retrieve data from a linked source account, as long as both accounts have transaction search enabled. </para><para> For retrieving data from X-Ray directly as opposed to the Transaction-Search Log group, see <a href="https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html">BatchGetTraces</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.StartXRTraceRetrievalCmdlet.EndTime"> <summary> <para> <para> The end of the time range to retrieve traces. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.StartXRTraceRetrievalCmdlet.StartTime"> <summary> <para> <para> The start of the time range to retrieve traces. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.StartXRTraceRetrievalCmdlet.TraceId"> <summary> <para> <para> Specify the trace IDs of the traces to be retrieved. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.StartXRTraceRetrievalCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RetrievalToken'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.StartTraceRetrievalResponse). Specifying the name of a property of type Amazon.XRay.Model.StartTraceRetrievalResponse 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.StartXRTraceRetrievalCmdlet.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.StopXRTraceRetrievalCmdlet"> <summary> Cancels an ongoing trace retrieval job initiated by <c>StartTraceRetrieval</c> using the provided <c>RetrievalToken</c>. A successful cancellation will return an HTTP 200 response. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.StopXRTraceRetrievalCmdlet.RetrievalToken"> <summary> <para> <para> Retrieval token. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.StopXRTraceRetrievalCmdlet.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.CancelTraceRetrievalResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.StopXRTraceRetrievalCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RetrievalToken parameter. The -PassThru parameter is deprecated, use -Select '^RetrievalToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.StopXRTraceRetrievalCmdlet.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.InsightsConfiguration_InsightsEnabled"> <summary> <para> <para>Set the InsightsEnabled value to true to enable insights or false to disable insights.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRGroupCmdlet.InsightsConfiguration_NotificationsEnabled"> <summary> <para> <para>Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.</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.UpdateXRIndexingRuleCmdlet"> <summary> Modifies an indexing rule’s configuration. <para> Indexing rules are used for determining the sampling rate for spans indexed from CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html">Transaction Search</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRIndexingRuleCmdlet.Probabilistic_DesiredSamplingPercentage"> <summary> <para> <para> Configured sampling percentage of traceIds. Note that sampling can be subject to limits to ensure completeness of data. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRIndexingRuleCmdlet.Name"> <summary> <para> <para> Name of the indexing rule to be updated. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRIndexingRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IndexingRule'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.UpdateIndexingRuleResponse). Specifying the name of a property of type Amazon.XRay.Model.UpdateIndexingRuleResponse 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.UpdateXRIndexingRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRIndexingRuleCmdlet.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 Amazon Web Services 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 <c>name</c> 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 <c>origin</c> 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.UpdateXRTraceSegmentDestinationCmdlet"> <summary> Modifies the destination of data sent to <c>PutTraceSegments</c>. The Transaction Search feature requires the CloudWatchLogs destination. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html">Transaction Search</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRTraceSegmentDestinationCmdlet.Destination"> <summary> <para> <para> The configured destination of trace segments. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRTraceSegmentDestinationCmdlet.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.UpdateTraceSegmentDestinationResponse). Specifying the name of a property of type Amazon.XRay.Model.UpdateTraceSegmentDestinationResponse 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.UpdateXRTraceSegmentDestinationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Destination parameter. The -PassThru parameter is deprecated, use -Select '^Destination' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.UpdateXRTraceSegmentDestinationCmdlet.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 Amazon Web Services KMS key in one of the following formats:</para><ul><li><para><b>Alias</b> - The name of the key. For example, <c>alias/MyKey</c>.</para></li><li><para><b>Key ID</b> - The KMS key ID of the key. For example, <c>ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</c>. Amazon Web Services X-Ray does not support asymmetric KMS keys.</para></li><li><para><b>ARN</b> - The full Amazon Resource Name of the key ID or alias. For example, <c>arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</c>. Use this format to specify a key in a different account.</para></li></ul><para>Omit this key if you set <c>Type</c> to <c>NONE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXREncryptionConfigCmdlet.Type"> <summary> <para> <para>The type of encryption. Set to <c>KMS</c> to use your own key for encryption. Set to <c>NONE</c> 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.WriteXRResourcePolicyCmdlet"> <summary> Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXRResourcePolicyCmdlet.BypassPolicyLockoutCheck"> <summary> <para> <para>A flag to indicate whether to bypass the resource policy lockout safety check.</para><important><para>Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.</para></important><para>Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent <c>PutResourcePolicy</c> request.</para><para>The default value is false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXRResourcePolicyCmdlet.PolicyDocument"> <summary> <para> <para>The resource policy document, which can be up to 5kb in size.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXRResourcePolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the resource policy. Must be unique within a specific Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXRResourcePolicyCmdlet.PolicyRevisionId"> <summary> <para> <para>Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id. The revision id is unique to each policy in the account.</para><para>If the policy revision id does not match the latest revision id, the operation will fail with an <c>InvalidPolicyRevisionIdException</c> exception. You can also provide a <c>PolicyRevisionId</c> of 0. In this case, the operation will fail with an <c>InvalidPolicyRevisionIdException</c> exception if a resource policy with the same name already exists. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXRResourcePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourcePolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.XRay.Model.PutResourcePolicyResponse). Specifying the name of a property of type Amazon.XRay.Model.PutResourcePolicyResponse 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.WriteXRResourcePolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyName parameter. The -PassThru parameter is deprecated, use -Select '^PolicyName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.XR.WriteXRResourcePolicyCmdlet.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 Amazon Web Services 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> Uploads segment documents to Amazon Web Services X-Ray. A segment document can be a completed segment, an in-progress segment, or an array of subsegments. <para> Segments must include the following fields. For the full segment document schema, see <a href="https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-api.html#xray-api-segmentdocuments.html">Amazon Web Services X-Ray Segment Documents</a> in the <i>Amazon Web Services X-Ray Developer Guide</i>. </para><para><b>Required segment document fields</b></para><ul><li><para><c>name</c> - The name of the service that handled the request. </para></li><li><para><c>id</c> - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits. </para></li><li><para><c>trace_id</c> - A unique identifier that connects all segments and subsegments originating from a single client request. </para></li><li><para><c>start_time</c> - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, <c>1480615200.010</c> or <c>1.480615200010E9</c>. </para></li><li><para><c>end_time</c> - Time the segment or subsegment was closed. For example, <c>1480615200.090</c> or <c>1.480615200090E9</c>. Specify either an <c>end_time</c> or <c>in_progress</c>. </para></li><li><para><c>in_progress</c> - Set to <c>true</c> instead of specifying an <c>end_time</c> to record that a segment has been started, but is not complete. Send an in-progress segment when your application receives a request that will take a long time to serve, to trace that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment. </para></li></ul><para> A <c>trace_id</c> consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. For trace IDs created by an X-Ray SDK, or by Amazon Web Services services integrated with X-Ray, a trace ID includes: </para><para><b>Trace ID Format</b></para><ul><li><para> The version number, for instance, <c>1</c>. </para></li><li><para> The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is <c>1480615200</c> seconds, or <c>58406520</c> in hexadecimal. </para></li><li><para> A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits. </para></li></ul><note><para> Trace IDs created via OpenTelemetry have a different format based on the <a href="https://www.w3.org/TR/trace-context/">W3C Trace Context specification</a>. A W3C trace ID must be formatted in the X-Ray trace ID format when sending to X-Ray. For example, a W3C trace ID <c>4efaaf4d1e8720b39541901950019ee5</c> should be formatted as <c>1-4efaaf4d-1e8720b39541901950019ee5</c> when sending to X-Ray. While X-Ray trace IDs include the original request timestamp in Unix epoch time, this is not required or validated. </para></note> </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> |