@aws-sdk/client-xray 3.696.0 → 3.698.0

package/dist-types/commands/PutTraceSegmentsCommand.d.ts

@@ -27,11 +27,11 @@ declare const PutTraceSegmentsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Uploads segment documents to Amazon Web Services X-Ray. The <a href="https://docs.aws.amazon.com/xray/index.html">X-Ray SDK</a> generates segment documents and sends them to the X-Ray daemon, which uploads them in
- *       batches. A segment document can be a completed segment, an in-progress segment, or an array of
+ * <p>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.</p>
  *          <p>Segments must include the following fields. For the full segment document schema, see
- *       <a href="https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html">Amazon Web Services X-Ray
+ *       <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>.</p>
  *          <p class="title">
  *             <b>Required segment document fields</b>
@@ -72,7 +72,8 @@ declare const PutTraceSegmentsCommand_base: {
  *             </li>
  *          </ul>
  *          <p>A <code>trace_id</code> consists of three numbers separated by hyphens. For example,
- *       1-58406520-a006649127e371903a2de979. This includes:</p>
+ *       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:</p>
  *          <p class="title">
  *             <b>Trace ID Format</b>
  *          </p>
@@ -90,6 +91,15 @@ declare const PutTraceSegmentsCommand_base: {
  *           digits.</p>
  *             </li>
  *          </ul>
+ *          <note>
+ *             <p>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 <code>4efaaf4d1e8720b39541901950019ee5</code> should be formatted as
+ *       <code>1-4efaaf4d-1e8720b39541901950019ee5</code> 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.
+ *     </p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/StartTraceRetrievalCommand.d.ts

@@ -0,0 +1,90 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { StartTraceRetrievalRequest, StartTraceRetrievalResult } from "../models/models_0";
+import { 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/smithy-client").CommandImpl<StartTraceRetrievalCommandInput, StartTraceRetrievalCommandOutput, XRayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: StartTraceRetrievalCommandInput): import("@smithy/smithy-client").CommandImpl<StartTraceRetrievalCommandInput, StartTraceRetrievalCommandOutput, XRayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>
+ *   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>.
+ * </p>
+ *          <p>API returns a <code>RetrievalToken</code>, which can be used with <code>ListRetrievedTraces</code> or <code>GetRetrievedTracesGraph</code> to fetch results. Retrievals will time out after 60 minutes. To execute long time ranges, consider segmenting into multiple retrievals.</p>
+ *          <p>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.</p>
+ *          <p>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>.</p>
+ * @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
+ * 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)
+ *  <p>The request is missing required parameters or has invalid parameters.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is
+ *       correct.</p>
+ *
+ * @throws {@link ThrottledException} (client fault)
+ *  <p>The request exceeds the maximum number of requests per second.</p>
+ *
+ * @throws {@link XRayServiceException}
+ * <p>Base exception class for all service exceptions from XRay service.</p>
+ *
+ * @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;
+        };
+    };
+}

package/dist-types/commands/UpdateIndexingRuleCommand.d.ts

@@ -0,0 +1,98 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateIndexingRuleRequest, UpdateIndexingRuleResult } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateIndexingRuleCommand}.
+ */
+export interface UpdateIndexingRuleCommandInput extends UpdateIndexingRuleRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateIndexingRuleCommand}.
+ */
+export interface UpdateIndexingRuleCommandOutput extends UpdateIndexingRuleResult, __MetadataBearer {
+}
+declare const UpdateIndexingRuleCommand_base: {
+    new (input: UpdateIndexingRuleCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateIndexingRuleCommandInput, UpdateIndexingRuleCommandOutput, XRayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateIndexingRuleCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateIndexingRuleCommandInput, UpdateIndexingRuleCommandOutput, XRayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>
+ * Modifies an indexing rule’s configuration.
+ * </p>
+ *          <p>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>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { XRayClient, UpdateIndexingRuleCommand } from "@aws-sdk/client-xray"; // ES Modules import
+ * // const { XRayClient, UpdateIndexingRuleCommand } = require("@aws-sdk/client-xray"); // CommonJS import
+ * const client = new XRayClient(config);
+ * const input = { // UpdateIndexingRuleRequest
+ *   Name: "STRING_VALUE", // required
+ *   Rule: { // IndexingRuleValueUpdate Union: only one key present
+ *     Probabilistic: { // ProbabilisticRuleValueUpdate
+ *       DesiredSamplingPercentage: Number("double"), // required
+ *     },
+ *   },
+ * };
+ * const command = new UpdateIndexingRuleCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateIndexingRuleResult
+ * //   IndexingRule: { // IndexingRule
+ * //     Name: "STRING_VALUE",
+ * //     ModifiedAt: new Date("TIMESTAMP"),
+ * //     Rule: { // IndexingRuleValue Union: only one key present
+ * //       Probabilistic: { // ProbabilisticRuleValue
+ * //         DesiredSamplingPercentage: Number("double"), // required
+ * //         ActualSamplingPercentage: Number("double"),
+ * //       },
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateIndexingRuleCommandInput - {@link UpdateIndexingRuleCommandInput}
+ * @returns {@link UpdateIndexingRuleCommandOutput}
+ * @see {@link UpdateIndexingRuleCommandInput} for command's `input` shape.
+ * @see {@link UpdateIndexingRuleCommandOutput} for command's `response` shape.
+ * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>The request is missing required parameters or has invalid parameters.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is
+ *       correct.</p>
+ *
+ * @throws {@link ThrottledException} (client fault)
+ *  <p>The request exceeds the maximum number of requests per second.</p>
+ *
+ * @throws {@link XRayServiceException}
+ * <p>Base exception class for all service exceptions from XRay service.</p>
+ *
+ * @public
+ */
+export declare class UpdateIndexingRuleCommand extends UpdateIndexingRuleCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateIndexingRuleRequest;
+            output: UpdateIndexingRuleResult;
+        };
+        sdk: {
+            input: UpdateIndexingRuleCommandInput;
+            output: UpdateIndexingRuleCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateTraceSegmentDestinationCommand.d.ts

@@ -0,0 +1,80 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateTraceSegmentDestinationRequest, UpdateTraceSegmentDestinationResult } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateTraceSegmentDestinationCommand}.
+ */
+export interface UpdateTraceSegmentDestinationCommandInput extends UpdateTraceSegmentDestinationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateTraceSegmentDestinationCommand}.
+ */
+export interface UpdateTraceSegmentDestinationCommandOutput extends UpdateTraceSegmentDestinationResult, __MetadataBearer {
+}
+declare const UpdateTraceSegmentDestinationCommand_base: {
+    new (input: UpdateTraceSegmentDestinationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateTraceSegmentDestinationCommandInput, UpdateTraceSegmentDestinationCommandOutput, XRayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [UpdateTraceSegmentDestinationCommandInput]): import("@smithy/smithy-client").CommandImpl<UpdateTraceSegmentDestinationCommandInput, UpdateTraceSegmentDestinationCommandOutput, XRayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>
+ *   Modifies the destination of data sent to <code>PutTraceSegments</code>. 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>.
+ * </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { XRayClient, UpdateTraceSegmentDestinationCommand } from "@aws-sdk/client-xray"; // ES Modules import
+ * // const { XRayClient, UpdateTraceSegmentDestinationCommand } = require("@aws-sdk/client-xray"); // CommonJS import
+ * const client = new XRayClient(config);
+ * const input = { // UpdateTraceSegmentDestinationRequest
+ *   Destination: "XRay" || "CloudWatchLogs",
+ * };
+ * const command = new UpdateTraceSegmentDestinationCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateTraceSegmentDestinationResult
+ * //   Destination: "XRay" || "CloudWatchLogs",
+ * //   Status: "PENDING" || "ACTIVE",
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateTraceSegmentDestinationCommandInput - {@link UpdateTraceSegmentDestinationCommandInput}
+ * @returns {@link UpdateTraceSegmentDestinationCommandOutput}
+ * @see {@link UpdateTraceSegmentDestinationCommandInput} for command's `input` shape.
+ * @see {@link UpdateTraceSegmentDestinationCommandOutput} for command's `response` shape.
+ * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>The request is missing required parameters or has invalid parameters.</p>
+ *
+ * @throws {@link ThrottledException} (client fault)
+ *  <p>The request exceeds the maximum number of requests per second.</p>
+ *
+ * @throws {@link XRayServiceException}
+ * <p>Base exception class for all service exceptions from XRay service.</p>
+ *
+ * @public
+ */
+export declare class UpdateTraceSegmentDestinationCommand extends UpdateTraceSegmentDestinationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateTraceSegmentDestinationRequest;
+            output: UpdateTraceSegmentDestinationResult;
+        };
+        sdk: {
+            input: UpdateTraceSegmentDestinationCommandInput;
+            output: UpdateTraceSegmentDestinationCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./BatchGetTracesCommand";
+export * from "./CancelTraceRetrievalCommand";
 export * from "./CreateGroupCommand";
 export * from "./CreateSamplingRuleCommand";
 export * from "./DeleteGroupCommand";
@@ -7,24 +8,31 @@ export * from "./DeleteSamplingRuleCommand";
 export * from "./GetEncryptionConfigCommand";
 export * from "./GetGroupCommand";
 export * from "./GetGroupsCommand";
+export * from "./GetIndexingRulesCommand";
 export * from "./GetInsightCommand";
 export * from "./GetInsightEventsCommand";
 export * from "./GetInsightImpactGraphCommand";
 export * from "./GetInsightSummariesCommand";
+export * from "./GetRetrievedTracesGraphCommand";
 export * from "./GetSamplingRulesCommand";
 export * from "./GetSamplingStatisticSummariesCommand";
 export * from "./GetSamplingTargetsCommand";
 export * from "./GetServiceGraphCommand";
 export * from "./GetTimeSeriesServiceStatisticsCommand";
 export * from "./GetTraceGraphCommand";
+export * from "./GetTraceSegmentDestinationCommand";
 export * from "./GetTraceSummariesCommand";
 export * from "./ListResourcePoliciesCommand";
+export * from "./ListRetrievedTracesCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./PutEncryptionConfigCommand";
 export * from "./PutResourcePolicyCommand";
 export * from "./PutTelemetryRecordsCommand";
 export * from "./PutTraceSegmentsCommand";
+export * from "./StartTraceRetrievalCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateGroupCommand";
+export * from "./UpdateIndexingRuleCommand";
 export * from "./UpdateSamplingRuleCommand";
+export * from "./UpdateTraceSegmentDestinationCommand";