import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ListRetrievedTracesRequest, ListRetrievedTracesResult } from "../models/models_0"; import type { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ListRetrievedTracesCommand}. */ export interface ListRetrievedTracesCommandInput extends ListRetrievedTracesRequest { } /** * @public * * The output of {@link ListRetrievedTracesCommand}. */ export interface ListRetrievedTracesCommandOutput extends ListRetrievedTracesResult, __MetadataBearer { } declare const ListRetrievedTracesCommand_base: { new (input: ListRetrievedTracesCommandInput): import("@smithy/core/client").CommandImpl; new (input: ListRetrievedTracesCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

* Retrieves a list of traces for a given RetrievalToken from the CloudWatch log group generated by Transaction Search. For information on what each trace returns, see BatchGetTraces. *

*

This API does not initiate a retrieval process. To start a trace retrieval, use StartTraceRetrieval, which generates the required RetrievalToken.

*

* When the RetrievalStatus is not COMPLETE, the API will return an empty response. Retry the request once the retrieval has completed to access the full list of traces.

*

For cross-account observability, this API can retrieve traces from linked accounts when CloudWatch log is set as the destination across relevant accounts. For more details, see CloudWatch cross-account observability.

*

For retrieving data from X-Ray directly as opposed to the Transaction Search generated log group, see BatchGetTraces.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { XRayClient, ListRetrievedTracesCommand } from "@aws-sdk/client-xray"; // ES Modules import * // const { XRayClient, ListRetrievedTracesCommand } = require("@aws-sdk/client-xray"); // CommonJS import * // import type { XRayClientConfig } from "@aws-sdk/client-xray"; * const config = {}; // type is XRayClientConfig * const client = new XRayClient(config); * const input = { // ListRetrievedTracesRequest * RetrievalToken: "STRING_VALUE", // required * TraceFormat: "XRAY" || "OTEL", * NextToken: "STRING_VALUE", * }; * const command = new ListRetrievedTracesCommand(input); * const response = await client.send(command); * // { // ListRetrievedTracesResult * // RetrievalStatus: "SCHEDULED" || "RUNNING" || "COMPLETE" || "FAILED" || "CANCELLED" || "TIMEOUT", * // TraceFormat: "XRAY" || "OTEL", * // Traces: [ // TraceSpanList * // { // RetrievedTrace * // Id: "STRING_VALUE", * // Duration: Number("double"), * // Spans: [ // SpanList * // { // Span * // Id: "STRING_VALUE", * // Document: "STRING_VALUE", * // }, * // ], * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param ListRetrievedTracesCommandInput - {@link ListRetrievedTracesCommandInput} * @returns {@link ListRetrievedTracesCommandOutput} * @see {@link ListRetrievedTracesCommandInput} for command's `input` shape. * @see {@link ListRetrievedTracesCommandOutput} for command's `response` shape. * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape. * * @throws {@link InvalidRequestException} (client fault) *

The request is missing required parameters or has invalid parameters.

* * @throws {@link ResourceNotFoundException} (client fault) *

The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is * correct.

* * @throws {@link ThrottledException} (client fault) *

The request exceeds the maximum number of requests per second.

* * @throws {@link XRayServiceException} *

Base exception class for all service exceptions from XRay service.

* * * @public */ export declare class ListRetrievedTracesCommand extends ListRetrievedTracesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ListRetrievedTracesRequest; output: ListRetrievedTracesResult; }; sdk: { input: ListRetrievedTracesCommandInput; output: ListRetrievedTracesCommandOutput; }; }; }