@aws-sdk/client-xray 3.35.0 → 3.38.0

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

@@ -6,91 +6,11 @@ export interface PutTraceSegmentsCommandInput extends PutTraceSegmentsRequest {
 }
 export interface PutTraceSegmentsCommandOutput extends PutTraceSegmentsResult, __MetadataBearer {
 }
-/**
- * <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
- *       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
- *         Segment Documents</a> in the <i>Amazon Web Services X-Ray Developer Guide</i>.</p>
- *          <p class="title">
- *             <b>Required segment document fields</b>
- *          </p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <code>name</code> - The name of the service that handled the request.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <code>id</code> - A 64-bit identifier for the segment, unique among segments in the same trace, in 16
- *           hexadecimal digits.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <code>trace_id</code> - A unique identifier that connects all segments and subsegments originating from
- *           a single client request.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <code>start_time</code> - Time the segment or subsegment was created, in floating point seconds in
- *           epoch time, accurate to milliseconds. For example, <code>1480615200.010</code> or
- *             <code>1.480615200010E9</code>.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <code>end_time</code> - Time the segment or subsegment was closed. For example,
- *             <code>1480615200.090</code> or <code>1.480615200090E9</code>. Specify either an <code>end_time</code> or
- *             <code>in_progress</code>.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <code>in_progress</code> - Set to <code>true</code> instead of specifying an <code>end_time</code> to
- *           record that a segment has been started, but is not complete. Send an in-progress segment when your application
- *           receives a request that will take a long time to serve, to trace that the request was received. When the
- *           response is sent, send the complete segment to overwrite the in-progress segment.</p>
- *             </li>
- *          </ul>
- *          <p>A <code>trace_id</code> consists of three numbers separated by hyphens. For example,
- *       1-58406520-a006649127e371903a2de979. This includes:</p>
- *          <p class="title">
- *             <b>Trace ID Format</b>
- *          </p>
- *          <ul>
- *             <li>
- *                <p>The version number, for instance, <code>1</code>.</p>
- *             </li>
- *             <li>
- *                <p>The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For
- *           example, 10:00AM December 2nd, 2016 PST in epoch time is <code>1480615200</code> seconds,
- *           or <code>58406520</code> in hexadecimal.</p>
- *             </li>
- *             <li>
- *                <p>A 96-bit identifier for the trace, globally unique, in 24 hexadecimal
- *           digits.</p>
- *             </li>
- *          </ul>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { XRayClient, PutTraceSegmentsCommand } from "@aws-sdk/client-xray"; // ES Modules import
- * // const { XRayClient, PutTraceSegmentsCommand } = require("@aws-sdk/client-xray"); // CommonJS import
- * const client = new XRayClient(config);
- * const command = new PutTraceSegmentsCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link PutTraceSegmentsCommandInput} for command's `input` shape.
- * @see {@link PutTraceSegmentsCommandOutput} for command's `response` shape.
- * @see {@link XRayClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class PutTraceSegmentsCommand extends $Command<PutTraceSegmentsCommandInput, PutTraceSegmentsCommandOutput, XRayClientResolvedConfig> {
     readonly input: PutTraceSegmentsCommandInput;
     constructor(input: PutTraceSegmentsCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutTraceSegmentsCommandInput, PutTraceSegmentsCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/TagResourceCommand.d.ts

@@ -6,29 +6,11 @@ export interface TagResourceCommandInput extends TagResourceRequest {
 }
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
-/**
- * <p>Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { XRayClient, TagResourceCommand } from "@aws-sdk/client-xray"; // ES Modules import
- * // const { XRayClient, TagResourceCommand } = require("@aws-sdk/client-xray"); // CommonJS import
- * const client = new XRayClient(config);
- * const command = new TagResourceCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link TagResourceCommandInput} for command's `input` shape.
- * @see {@link TagResourceCommandOutput} for command's `response` shape.
- * @see {@link XRayClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, XRayClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     constructor(input: TagResourceCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts

@@ -6,30 +6,11 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
-/**
- * <p>Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system
- *       tags (those with an <code>aws:</code> prefix).</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { XRayClient, UntagResourceCommand } from "@aws-sdk/client-xray"; // ES Modules import
- * // const { XRayClient, UntagResourceCommand } = require("@aws-sdk/client-xray"); // CommonJS import
- * const client = new XRayClient(config);
- * const command = new UntagResourceCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link UntagResourceCommandInput} for command's `input` shape.
- * @see {@link UntagResourceCommandOutput} for command's `response` shape.
- * @see {@link XRayClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, XRayClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     constructor(input: UntagResourceCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts

@@ -6,29 +6,11 @@ export interface UpdateGroupCommandInput extends UpdateGroupRequest {
 }
 export interface UpdateGroupCommandOutput extends UpdateGroupResult, __MetadataBearer {
 }
-/**
- * <p>Updates a group resource.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { XRayClient, UpdateGroupCommand } from "@aws-sdk/client-xray"; // ES Modules import
- * // const { XRayClient, UpdateGroupCommand } = require("@aws-sdk/client-xray"); // CommonJS import
- * const client = new XRayClient(config);
- * const command = new UpdateGroupCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link UpdateGroupCommandInput} for command's `input` shape.
- * @see {@link UpdateGroupCommandOutput} for command's `response` shape.
- * @see {@link XRayClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class UpdateGroupCommand extends $Command<UpdateGroupCommandInput, UpdateGroupCommandOutput, XRayClientResolvedConfig> {
     readonly input: UpdateGroupCommandInput;
     constructor(input: UpdateGroupCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateGroupCommandInput, UpdateGroupCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/UpdateSamplingRuleCommand.d.ts

@@ -6,29 +6,11 @@ export interface UpdateSamplingRuleCommandInput extends UpdateSamplingRuleReques
 }
 export interface UpdateSamplingRuleCommandOutput extends UpdateSamplingRuleResult, __MetadataBearer {
 }
-/**
- * <p>Modifies a sampling rule's configuration.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { XRayClient, UpdateSamplingRuleCommand } from "@aws-sdk/client-xray"; // ES Modules import
- * // const { XRayClient, UpdateSamplingRuleCommand } = require("@aws-sdk/client-xray"); // CommonJS import
- * const client = new XRayClient(config);
- * const command = new UpdateSamplingRuleCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link UpdateSamplingRuleCommandInput} for command's `input` shape.
- * @see {@link UpdateSamplingRuleCommandOutput} for command's `response` shape.
- * @see {@link XRayClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class UpdateSamplingRuleCommand extends $Command<UpdateSamplingRuleCommandInput, UpdateSamplingRuleCommandOutput, XRayClientResolvedConfig> {
     readonly input: UpdateSamplingRuleCommandInput;
     constructor(input: UpdateSamplingRuleCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateSamplingRuleCommandInput, UpdateSamplingRuleCommandOutput>;
     private serialize;
     private deserialize;

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

@@ -0,0 +1,27 @@
+export * from "./BatchGetTracesCommand";
+export * from "./CreateGroupCommand";
+export * from "./CreateSamplingRuleCommand";
+export * from "./DeleteGroupCommand";
+export * from "./DeleteSamplingRuleCommand";
+export * from "./GetEncryptionConfigCommand";
+export * from "./GetGroupCommand";
+export * from "./GetGroupsCommand";
+export * from "./GetInsightCommand";
+export * from "./GetInsightEventsCommand";
+export * from "./GetInsightImpactGraphCommand";
+export * from "./GetInsightSummariesCommand";
+export * from "./GetSamplingRulesCommand";
+export * from "./GetSamplingStatisticSummariesCommand";
+export * from "./GetSamplingTargetsCommand";
+export * from "./GetServiceGraphCommand";
+export * from "./GetTimeSeriesServiceStatisticsCommand";
+export * from "./GetTraceGraphCommand";
+export * from "./GetTraceSummariesCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./PutEncryptionConfigCommand";
+export * from "./PutTelemetryRecordsCommand";
+export * from "./PutTraceSegmentsCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdateGroupCommand";
+export * from "./UpdateSamplingRuleCommand";

package/dist-types/ts3.4/index.d.ts

@@ -1,41 +1,5 @@
-export * from "./XRayClient";
 export * from "./XRay";
-export * from "./commands/BatchGetTracesCommand";
-export * from "./pagination/BatchGetTracesPaginator";
-export * from "./commands/CreateGroupCommand";
-export * from "./commands/CreateSamplingRuleCommand";
-export * from "./commands/DeleteGroupCommand";
-export * from "./commands/DeleteSamplingRuleCommand";
-export * from "./commands/GetEncryptionConfigCommand";
-export * from "./commands/GetGroupCommand";
-export * from "./commands/GetGroupsCommand";
-export * from "./pagination/GetGroupsPaginator";
-export * from "./commands/GetInsightCommand";
-export * from "./commands/GetInsightEventsCommand";
-export * from "./pagination/GetInsightEventsPaginator";
-export * from "./commands/GetInsightImpactGraphCommand";
-export * from "./commands/GetInsightSummariesCommand";
-export * from "./pagination/GetInsightSummariesPaginator";
-export * from "./commands/GetSamplingRulesCommand";
-export * from "./pagination/GetSamplingRulesPaginator";
-export * from "./commands/GetSamplingStatisticSummariesCommand";
-export * from "./pagination/GetSamplingStatisticSummariesPaginator";
-export * from "./commands/GetSamplingTargetsCommand";
-export * from "./commands/GetServiceGraphCommand";
-export * from "./pagination/GetServiceGraphPaginator";
-export * from "./commands/GetTimeSeriesServiceStatisticsCommand";
-export * from "./pagination/GetTimeSeriesServiceStatisticsPaginator";
-export * from "./commands/GetTraceGraphCommand";
-export * from "./pagination/GetTraceGraphPaginator";
-export * from "./commands/GetTraceSummariesCommand";
-export * from "./pagination/GetTraceSummariesPaginator";
-export * from "./commands/ListTagsForResourceCommand";
-export * from "./commands/PutEncryptionConfigCommand";
-export * from "./commands/PutTelemetryRecordsCommand";
-export * from "./commands/PutTraceSegmentsCommand";
-export * from "./commands/TagResourceCommand";
-export * from "./commands/UntagResourceCommand";
-export * from "./commands/UpdateGroupCommand";
-export * from "./commands/UpdateSamplingRuleCommand";
-export * from "./pagination/Interfaces";
-export * from "./models/index";
+export * from "./XRayClient";
+export * from "./commands";
+export * from "./models";
+export * from "./pagination";