aws xray get-trace-summaries
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 BatchGetTraces. 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 api.example.com: service("api.example.com") This filter expression finds traces that have an annotation named account with the value 12345: annotation.account = "12345" For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the AWS X-Ray Developer Guide
Options
Name | Description |
---|---|
--start-time <timestamp> | The start of the time frame for which to retrieve traces |
--end-time <timestamp> | The end of the time frame for which to retrieve traces |
--time-range-type <string> | A parameter to indicate whether to query trace summaries by TraceId or Event time |
--sampling | Set to true to get summaries for only a subset of available traces |
--no-sampling | Set to true to get summaries for only a subset of available traces |
--sampling-strategy <structure> | A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value |
--filter-expression <string> | Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements |
--next-token <string> | Specify the pagination token returned by a previous request to retrieve the next page of results |
--cli-input-json <string> | Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally |
--starting-token <string> | A token to specify where to start paginating. This is the NextToken from a previously truncated response. For usage examples, see Pagination in the AWS Command Line Interface User Guide |
--max-items <integer> | The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI. For usage examples, see Pagination in the AWS Command Line Interface User Guide |
--generate-cli-skeleton <string> | Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command |