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

* Initiates a trace retrieval process using the specified time range and for the given trace IDs in the Transaction Search generated CloudWatch log group. For more information, see Transaction Search. *

*

API returns a RetrievalToken, which can be used with ListRetrievedTraces or GetRetrievedTracesGraph to fetch results. Retrievals will time out after 60 minutes. To execute long time ranges, consider segmenting into multiple retrievals.

*

If you are using CloudWatch cross-account observability, 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.

*

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { XRayClient, StartTraceRetrievalCommand } from "@aws-sdk/client-xray"; // ES Modules import * // const { XRayClient, StartTraceRetrievalCommand } = 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 = { // StartTraceRetrievalRequest * TraceIds: [ // TraceIdListForRetrieval // required * "STRING_VALUE", * ], * StartTime: new Date("TIMESTAMP"), // required * EndTime: new Date("TIMESTAMP"), // required * }; * const command = new StartTraceRetrievalCommand(input); * const response = await client.send(command); * // { // StartTraceRetrievalResult * // RetrievalToken: "STRING_VALUE", * // }; * * ``` * * @param StartTraceRetrievalCommandInput - {@link StartTraceRetrievalCommandInput} * @returns {@link StartTraceRetrievalCommandOutput} * @see {@link StartTraceRetrievalCommandInput} for command's `input` shape. * @see {@link StartTraceRetrievalCommandOutput} 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 StartTraceRetrievalCommand extends StartTraceRetrievalCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartTraceRetrievalRequest; output: StartTraceRetrievalResult; }; sdk: { input: StartTraceRetrievalCommandInput; output: StartTraceRetrievalCommandOutput; }; }; }