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

* Retrieves a service graph for traces based on the specified RetrievalToken from the CloudWatch log group generated by Transaction Search. This API does not initiate a retrieval job. You must first execute StartTraceRetrieval to obtain the required RetrievalToken. *

*

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.

*

The response is empty until the RetrievalStatus is COMPLETE. Retry the request after the status changes from RUNNING or SCHEDULED to COMPLETE to access the full service graph.

*

* When CloudWatch log is the destination, this API can support cross-account observability and service graph retrieval across linked accounts.

*

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { XRayClient, GetRetrievedTracesGraphCommand } from "@aws-sdk/client-xray"; // ES Modules import * // const { XRayClient, GetRetrievedTracesGraphCommand } = 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 = { // GetRetrievedTracesGraphRequest * RetrievalToken: "STRING_VALUE", // required * NextToken: "STRING_VALUE", * }; * const command = new GetRetrievedTracesGraphCommand(input); * const response = await client.send(command); * // { // GetRetrievedTracesGraphResult * // RetrievalStatus: "SCHEDULED" || "RUNNING" || "COMPLETE" || "FAILED" || "CANCELLED" || "TIMEOUT", * // Services: [ // RetrievedServicesList * // { // RetrievedService * // Service: { // Service * // ReferenceId: Number("int"), * // Name: "STRING_VALUE", * // Names: [ // ServiceNames * // "STRING_VALUE", * // ], * // Root: true || false, * // AccountId: "STRING_VALUE", * // Type: "STRING_VALUE", * // State: "STRING_VALUE", * // StartTime: new Date("TIMESTAMP"), * // EndTime: new Date("TIMESTAMP"), * // Edges: [ // EdgeList * // { // Edge * // ReferenceId: Number("int"), * // StartTime: new Date("TIMESTAMP"), * // EndTime: new Date("TIMESTAMP"), * // SummaryStatistics: { // EdgeStatistics * // OkCount: Number("long"), * // ErrorStatistics: { // ErrorStatistics * // ThrottleCount: Number("long"), * // OtherCount: Number("long"), * // TotalCount: Number("long"), * // }, * // FaultStatistics: { // FaultStatistics * // OtherCount: Number("long"), * // TotalCount: Number("long"), * // }, * // TotalCount: Number("long"), * // TotalResponseTime: Number("double"), * // }, * // ResponseTimeHistogram: [ // Histogram * // { // HistogramEntry * // Value: Number("double"), * // Count: Number("int"), * // }, * // ], * // Aliases: [ // AliasList * // { // Alias * // Name: "STRING_VALUE", * // Names: [ // AliasNames * // "STRING_VALUE", * // ], * // Type: "STRING_VALUE", * // }, * // ], * // EdgeType: "STRING_VALUE", * // ReceivedEventAgeHistogram: [ * // { * // Value: Number("double"), * // Count: Number("int"), * // }, * // ], * // }, * // ], * // SummaryStatistics: { // ServiceStatistics * // OkCount: Number("long"), * // ErrorStatistics: { * // ThrottleCount: Number("long"), * // OtherCount: Number("long"), * // TotalCount: Number("long"), * // }, * // FaultStatistics: { * // OtherCount: Number("long"), * // TotalCount: Number("long"), * // }, * // TotalCount: Number("long"), * // TotalResponseTime: Number("double"), * // }, * // DurationHistogram: [ * // { * // Value: Number("double"), * // Count: Number("int"), * // }, * // ], * // ResponseTimeHistogram: [ * // { * // Value: Number("double"), * // Count: Number("int"), * // }, * // ], * // }, * // Links: [ // LinksList * // { // GraphLink * // ReferenceType: "STRING_VALUE", * // SourceTraceId: "STRING_VALUE", * // DestinationTraceIds: [ // TraceIdList * // "STRING_VALUE", * // ], * // }, * // ], * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param GetRetrievedTracesGraphCommandInput - {@link GetRetrievedTracesGraphCommandInput} * @returns {@link GetRetrievedTracesGraphCommandOutput} * @see {@link GetRetrievedTracesGraphCommandInput} for command's `input` shape. * @see {@link GetRetrievedTracesGraphCommandOutput} 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 GetRetrievedTracesGraphCommand extends GetRetrievedTracesGraphCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetRetrievedTracesGraphRequest; output: GetRetrievedTracesGraphResult; }; sdk: { input: GetRetrievedTracesGraphCommandInput; output: GetRetrievedTracesGraphCommandOutput; }; }; }