@aws-sdk/client-xray 3.295.0 → 3.297.0

package/dist-types/XRay.d.ts

@@ -31,11 +31,13 @@ import { UpdateGroupCommandInput, UpdateGroupCommandOutput } from "./commands/Up
 import { UpdateSamplingRuleCommandInput, UpdateSamplingRuleCommandOutput } from "./commands/UpdateSamplingRuleCommand";
 import { XRayClient } from "./XRayClient";
 /**
+ * @public
  * <p>Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps
  *       and other data created by processing those traces.</p>
  */
 export declare class XRay extends XRayClient {
     /**
+     * @public
      * <p>Retrieves a list of traces specified by ID. Each trace is a collection of segment
      *       documents that originates from a single request. Use <code>GetTraceSummaries</code> to get a
      *       list of trace IDs.</p>
@@ -44,12 +46,14 @@ export declare class XRay extends XRayClient {
     batchGetTraces(args: BatchGetTracesCommandInput, cb: (err: any, data?: BatchGetTracesCommandOutput) => void): void;
     batchGetTraces(args: BatchGetTracesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetTracesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a group resource with a name and a filter expression. </p>
      */
     createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateGroupCommandOutput>;
     createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void;
     createGroup(args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a rule to control sampling behavior for instrumented applications. Services
      *          retrieve rules with <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html">GetSamplingRules</a>, and evaluate each rule in ascending
      *          order of <i>priority</i> for each request. If a rule matches, the service
@@ -62,42 +66,49 @@ export declare class XRay extends XRayClient {
     createSamplingRule(args: CreateSamplingRuleCommandInput, cb: (err: any, data?: CreateSamplingRuleCommandOutput) => void): void;
     createSamplingRule(args: CreateSamplingRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSamplingRuleCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a group resource.</p>
      */
     deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGroupCommandOutput>;
     deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
     deleteGroup(args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a resource policy from the target Amazon Web Services account.</p>
      */
     deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResourcePolicyCommandOutput>;
     deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
     deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a sampling rule.</p>
      */
     deleteSamplingRule(args: DeleteSamplingRuleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSamplingRuleCommandOutput>;
     deleteSamplingRule(args: DeleteSamplingRuleCommandInput, cb: (err: any, data?: DeleteSamplingRuleCommandOutput) => void): void;
     deleteSamplingRule(args: DeleteSamplingRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSamplingRuleCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the current encryption configuration for X-Ray data.</p>
      */
     getEncryptionConfig(args: GetEncryptionConfigCommandInput, options?: __HttpHandlerOptions): Promise<GetEncryptionConfigCommandOutput>;
     getEncryptionConfig(args: GetEncryptionConfigCommandInput, cb: (err: any, data?: GetEncryptionConfigCommandOutput) => void): void;
     getEncryptionConfig(args: GetEncryptionConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEncryptionConfigCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves group resource details.</p>
      */
     getGroup(args: GetGroupCommandInput, options?: __HttpHandlerOptions): Promise<GetGroupCommandOutput>;
     getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void;
     getGroup(args: GetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves all active group details.</p>
      */
     getGroups(args: GetGroupsCommandInput, options?: __HttpHandlerOptions): Promise<GetGroupsCommandOutput>;
     getGroups(args: GetGroupsCommandInput, cb: (err: any, data?: GetGroupsCommandOutput) => void): void;
     getGroups(args: GetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the summary information of an insight. This includes impact to clients and
      *          root cause services, the top anomalous services, the category, the state of the insight,
      *          and the start and end time of the insight.</p>
@@ -106,6 +117,7 @@ export declare class XRay extends XRayClient {
     getInsight(args: GetInsightCommandInput, cb: (err: any, data?: GetInsightCommandOutput) => void): void;
     getInsight(args: GetInsightCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInsightCommandOutput) => void): void;
     /**
+     * @public
      * <p>X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an
      *          event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray
      *          console.</p>
@@ -114,6 +126,7 @@ export declare class XRay extends XRayClient {
     getInsightEvents(args: GetInsightEventsCommandInput, cb: (err: any, data?: GetInsightEventsCommandOutput) => void): void;
     getInsightEvents(args: GetInsightEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInsightEventsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only
      *          structural information. For a complete service graph, use this API with the GetServiceGraph API.</p>
      */
@@ -121,24 +134,28 @@ export declare class XRay extends XRayClient {
     getInsightImpactGraph(args: GetInsightImpactGraphCommandInput, cb: (err: any, data?: GetInsightImpactGraphCommandOutput) => void): void;
     getInsightImpactGraph(args: GetInsightImpactGraphCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInsightImpactGraphCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the summaries of all insights in the specified group matching the provided filter values.</p>
      */
     getInsightSummaries(args: GetInsightSummariesCommandInput, options?: __HttpHandlerOptions): Promise<GetInsightSummariesCommandOutput>;
     getInsightSummaries(args: GetInsightSummariesCommandInput, cb: (err: any, data?: GetInsightSummariesCommandOutput) => void): void;
     getInsightSummaries(args: GetInsightSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInsightSummariesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves all sampling rules.</p>
      */
     getSamplingRules(args: GetSamplingRulesCommandInput, options?: __HttpHandlerOptions): Promise<GetSamplingRulesCommandOutput>;
     getSamplingRules(args: GetSamplingRulesCommandInput, cb: (err: any, data?: GetSamplingRulesCommandOutput) => void): void;
     getSamplingRules(args: GetSamplingRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSamplingRulesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves information about recent sampling results for all sampling rules.</p>
      */
     getSamplingStatisticSummaries(args: GetSamplingStatisticSummariesCommandInput, options?: __HttpHandlerOptions): Promise<GetSamplingStatisticSummariesCommandOutput>;
     getSamplingStatisticSummaries(args: GetSamplingStatisticSummariesCommandInput, cb: (err: any, data?: GetSamplingStatisticSummariesCommandOutput) => void): void;
     getSamplingStatisticSummaries(args: GetSamplingStatisticSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSamplingStatisticSummariesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Requests a sampling quota for rules that the service is using to sample requests.
      *       </p>
      */
@@ -146,6 +163,7 @@ export declare class XRay extends XRayClient {
     getSamplingTargets(args: GetSamplingTargetsCommandInput, cb: (err: any, data?: GetSamplingTargetsCommandOutput) => void): void;
     getSamplingTargets(args: GetSamplingTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSamplingTargetsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves a document that describes services that process incoming requests, and
      *       downstream services that they call as a result. Root services process incoming requests and
      *       make calls to downstream services. Root services are applications that use the <a href="https://docs.aws.amazon.com/xray/index.html">Amazon Web Services X-Ray SDK</a>.
@@ -156,6 +174,7 @@ export declare class XRay extends XRayClient {
     getServiceGraph(args: GetServiceGraphCommandInput, cb: (err: any, data?: GetServiceGraphCommandOutput) => void): void;
     getServiceGraph(args: GetServiceGraphCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceGraphCommandOutput) => void): void;
     /**
+     * @public
      * <p>Get an aggregation of service statistics defined by a specific time
      *             range.</p>
      */
@@ -163,12 +182,14 @@ export declare class XRay extends XRayClient {
     getTimeSeriesServiceStatistics(args: GetTimeSeriesServiceStatisticsCommandInput, cb: (err: any, data?: GetTimeSeriesServiceStatisticsCommandOutput) => void): void;
     getTimeSeriesServiceStatistics(args: GetTimeSeriesServiceStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTimeSeriesServiceStatisticsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves a service graph for one or more specific trace IDs.</p>
      */
     getTraceGraph(args: GetTraceGraphCommandInput, options?: __HttpHandlerOptions): Promise<GetTraceGraphCommandOutput>;
     getTraceGraph(args: GetTraceGraphCommandInput, cb: (err: any, data?: GetTraceGraphCommandOutput) => void): void;
     getTraceGraph(args: GetTraceGraphCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTraceGraphCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves IDs and annotations for traces available for a specified time frame using an
      *       optional filter. To get the full traces, pass the trace IDs to
      *       <code>BatchGetTraces</code>.</p>
@@ -191,24 +212,28 @@ export declare class XRay extends XRayClient {
     getTraceSummaries(args: GetTraceSummariesCommandInput, cb: (err: any, data?: GetTraceSummariesCommandOutput) => void): void;
     getTraceSummaries(args: GetTraceSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTraceSummariesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns the list of resource policies in the target Amazon Web Services account.</p>
      */
     listResourcePolicies(args: ListResourcePoliciesCommandInput, options?: __HttpHandlerOptions): Promise<ListResourcePoliciesCommandOutput>;
     listResourcePolicies(args: ListResourcePoliciesCommandInput, cb: (err: any, data?: ListResourcePoliciesCommandOutput) => void): void;
     listResourcePolicies(args: ListResourcePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcePoliciesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.</p>
      */
     listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
     listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the encryption configuration for X-Ray data.</p>
      */
     putEncryptionConfig(args: PutEncryptionConfigCommandInput, options?: __HttpHandlerOptions): Promise<PutEncryptionConfigCommandOutput>;
     putEncryptionConfig(args: PutEncryptionConfigCommandInput, cb: (err: any, data?: PutEncryptionConfigCommandOutput) => void): void;
     putEncryptionConfig(args: PutEncryptionConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEncryptionConfigCommandOutput) => void): void;
     /**
+     * @public
      * <p>
      *             Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to
      *             access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account.
@@ -220,12 +245,14 @@ export declare class XRay extends XRayClient {
     putResourcePolicy(args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
     putResourcePolicy(args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Used by the Amazon Web Services X-Ray daemon to upload telemetry.</p>
      */
     putTelemetryRecords(args: PutTelemetryRecordsCommandInput, options?: __HttpHandlerOptions): Promise<PutTelemetryRecordsCommandOutput>;
     putTelemetryRecords(args: PutTelemetryRecordsCommandInput, cb: (err: any, data?: PutTelemetryRecordsCommandOutput) => void): void;
     putTelemetryRecords(args: PutTelemetryRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutTelemetryRecordsCommandOutput) => void): void;
     /**
+     * @public
      * <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>
@@ -294,12 +321,14 @@ export declare class XRay extends XRayClient {
     putTraceSegments(args: PutTraceSegmentsCommandInput, cb: (err: any, data?: PutTraceSegmentsCommandOutput) => void): void;
     putTraceSegments(args: PutTraceSegmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutTraceSegmentsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.</p>
      */
     tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <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>
      */
@@ -307,12 +336,14 @@ export declare class XRay extends XRayClient {
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates a group resource.</p>
      */
     updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGroupCommandOutput>;
     updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
     updateGroup(args: UpdateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
     /**
+     * @public
      * <p>Modifies a sampling rule's configuration.</p>
      */
     updateSamplingRule(args: UpdateSamplingRuleCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSamplingRuleCommandOutput>;

package/dist-types/XRayClient.d.ts

@@ -38,15 +38,24 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
 import { UpdateGroupCommandInput, UpdateGroupCommandOutput } from "./commands/UpdateGroupCommand";
 import { UpdateSamplingRuleCommandInput, UpdateSamplingRuleCommandOutput } from "./commands/UpdateSamplingRuleCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = BatchGetTracesCommandInput | CreateGroupCommandInput | CreateSamplingRuleCommandInput | DeleteGroupCommandInput | DeleteResourcePolicyCommandInput | DeleteSamplingRuleCommandInput | GetEncryptionConfigCommandInput | GetGroupCommandInput | GetGroupsCommandInput | GetInsightCommandInput | GetInsightEventsCommandInput | GetInsightImpactGraphCommandInput | GetInsightSummariesCommandInput | GetSamplingRulesCommandInput | GetSamplingStatisticSummariesCommandInput | GetSamplingTargetsCommandInput | GetServiceGraphCommandInput | GetTimeSeriesServiceStatisticsCommandInput | GetTraceGraphCommandInput | GetTraceSummariesCommandInput | ListResourcePoliciesCommandInput | ListTagsForResourceCommandInput | PutEncryptionConfigCommandInput | PutResourcePolicyCommandInput | PutTelemetryRecordsCommandInput | PutTraceSegmentsCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateGroupCommandInput | UpdateSamplingRuleCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = BatchGetTracesCommandOutput | CreateGroupCommandOutput | CreateSamplingRuleCommandOutput | DeleteGroupCommandOutput | DeleteResourcePolicyCommandOutput | DeleteSamplingRuleCommandOutput | GetEncryptionConfigCommandOutput | GetGroupCommandOutput | GetGroupsCommandOutput | GetInsightCommandOutput | GetInsightEventsCommandOutput | GetInsightImpactGraphCommandOutput | GetInsightSummariesCommandOutput | GetSamplingRulesCommandOutput | GetSamplingStatisticSummariesCommandOutput | GetSamplingTargetsCommandOutput | GetServiceGraphCommandOutput | GetTimeSeriesServiceStatisticsCommandOutput | GetTraceGraphCommandOutput | GetTraceSummariesCommandOutput | ListResourcePoliciesCommandOutput | ListTagsForResourceCommandOutput | PutEncryptionConfigCommandOutput | PutResourcePolicyCommandOutput | PutTelemetryRecordsCommandOutput | PutTraceSegmentsCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateGroupCommandOutput | UpdateSamplingRuleCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -136,23 +145,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type XRayClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of XRayClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of XRayClient class constructor that set the region, credentials and other options.
  */
 export interface XRayClientConfig extends XRayClientConfigType {
 }
+/**
+ * @public
+ */
 type XRayClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of XRayClient class. This is resolved and normalized from the {@link XRayClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of XRayClient class. This is resolved and normalized from the {@link XRayClientConfig | constructor configuration interface}.
  */
 export interface XRayClientResolvedConfig extends XRayClientResolvedConfigType {
 }
 /**
+ * @public
  * <p>Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps
  *       and other data created by processing those traces.</p>
  */

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BatchGetTracesRequest, BatchGetTracesResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
 /**
+ * @public
+ *
  * The input for {@link BatchGetTracesCommand}.
  */
 export interface BatchGetTracesCommandInput extends BatchGetTracesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchGetTracesCommand}.
  */
 export interface BatchGetTracesCommandOutput extends BatchGetTracesResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Retrieves a list of traces specified by ID. Each trace is a collection of segment
  *       documents that originates from a single request. Use <code>GetTraceSummaries</code> to get a
  *       list of trace IDs.</p>
@@ -27,6 +32,8 @@ export interface BatchGetTracesCommandOutput extends BatchGetTracesResult, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchGetTracesCommandInput - {@link BatchGetTracesCommandInput}
+ * @returns {@link BatchGetTracesCommandOutput}
  * @see {@link BatchGetTracesCommandInput} for command's `input` shape.
  * @see {@link BatchGetTracesCommandOutput} for command's `response` shape.
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -42,11 +49,20 @@ export interface BatchGetTracesCommandOutput extends BatchGetTracesResult, __Met
 export declare class BatchGetTracesCommand extends $Command<BatchGetTracesCommandInput, BatchGetTracesCommandOutput, XRayClientResolvedConfig> {
     readonly input: BatchGetTracesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchGetTracesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetTracesCommandInput, BatchGetTracesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CreateGroupRequest, CreateGroupResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
 /**
+ * @public
+ *
  * The input for {@link CreateGroupCommand}.
  */
 export interface CreateGroupCommandInput extends CreateGroupRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateGroupCommand}.
  */
 export interface CreateGroupCommandOutput extends CreateGroupResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a group resource with a name and a filter expression. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateGroupCommandOutput extends CreateGroupResult, __MetadataB
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateGroupCommandInput - {@link CreateGroupCommandInput}
+ * @returns {@link CreateGroupCommandOutput}
  * @see {@link CreateGroupCommandInput} for command's `input` shape.
  * @see {@link CreateGroupCommandOutput} for command's `response` shape.
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -40,11 +47,20 @@ export interface CreateGroupCommandOutput extends CreateGroupResult, __MetadataB
 export declare class CreateGroupCommand extends $Command<CreateGroupCommandInput, CreateGroupCommandOutput, XRayClientResolvedConfig> {
     readonly input: CreateGroupCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateGroupCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateGroupCommandInput, CreateGroupCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CreateSamplingRuleRequest, CreateSamplingRuleResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
 /**
+ * @public
+ *
  * The input for {@link CreateSamplingRuleCommand}.
  */
 export interface CreateSamplingRuleCommandInput extends CreateSamplingRuleRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateSamplingRuleCommand}.
  */
 export interface CreateSamplingRuleCommandOutput extends CreateSamplingRuleResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a rule to control sampling behavior for instrumented applications. Services
  *          retrieve rules with <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html">GetSamplingRules</a>, and evaluate each rule in ascending
  *          order of <i>priority</i> for each request. If a rule matches, the service
@@ -31,6 +36,8 @@ export interface CreateSamplingRuleCommandOutput extends CreateSamplingRuleResul
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateSamplingRuleCommandInput - {@link CreateSamplingRuleCommandInput}
+ * @returns {@link CreateSamplingRuleCommandOutput}
  * @see {@link CreateSamplingRuleCommandInput} for command's `input` shape.
  * @see {@link CreateSamplingRuleCommandOutput} for command's `response` shape.
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -49,11 +56,20 @@ export interface CreateSamplingRuleCommandOutput extends CreateSamplingRuleResul
 export declare class CreateSamplingRuleCommand extends $Command<CreateSamplingRuleCommandInput, CreateSamplingRuleCommandOutput, XRayClientResolvedConfig> {
     readonly input: CreateSamplingRuleCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateSamplingRuleCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateSamplingRuleCommandInput, CreateSamplingRuleCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DeleteGroupRequest, DeleteGroupResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
 /**
+ * @public
+ *
  * The input for {@link DeleteGroupCommand}.
  */
 export interface DeleteGroupCommandInput extends DeleteGroupRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DeleteGroupCommand}.
  */
 export interface DeleteGroupCommandOutput extends DeleteGroupResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Deletes a group resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResult, __MetadataB
  * const response = await client.send(command);
  * ```
  *
+ * @param DeleteGroupCommandInput - {@link DeleteGroupCommandInput}
+ * @returns {@link DeleteGroupCommandOutput}
  * @see {@link DeleteGroupCommandInput} for command's `input` shape.
  * @see {@link DeleteGroupCommandOutput} for command's `response` shape.
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -40,11 +47,20 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResult, __MetadataB
 export declare class DeleteGroupCommand extends $Command<DeleteGroupCommandInput, DeleteGroupCommandOutput, XRayClientResolvedConfig> {
     readonly input: DeleteGroupCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DeleteGroupCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteGroupCommandInput, DeleteGroupCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DeleteResourcePolicyRequest, DeleteResourcePolicyResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
 /**
+ * @public
+ *
  * The input for {@link DeleteResourcePolicyCommand}.
  */
 export interface DeleteResourcePolicyCommandInput extends DeleteResourcePolicyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DeleteResourcePolicyCommand}.
  */
 export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Deletes a resource policy from the target Amazon Web Services account.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
  * const response = await client.send(command);
  * ```
  *
+ * @param DeleteResourcePolicyCommandInput - {@link DeleteResourcePolicyCommandInput}
+ * @returns {@link DeleteResourcePolicyCommandOutput}
  * @see {@link DeleteResourcePolicyCommandInput} for command's `input` shape.
  * @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape.
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
 export declare class DeleteResourcePolicyCommand extends $Command<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput, XRayClientResolvedConfig> {
     readonly input: DeleteResourcePolicyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DeleteResourcePolicyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DeleteSamplingRuleRequest, DeleteSamplingRuleResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
 /**
+ * @public
+ *
  * The input for {@link DeleteSamplingRuleCommand}.
  */
 export interface DeleteSamplingRuleCommandInput extends DeleteSamplingRuleRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DeleteSamplingRuleCommand}.
  */
 export interface DeleteSamplingRuleCommandOutput extends DeleteSamplingRuleResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Deletes a sampling rule.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteSamplingRuleCommandOutput extends DeleteSamplingRuleResul
  * const response = await client.send(command);
  * ```
  *
+ * @param DeleteSamplingRuleCommandInput - {@link DeleteSamplingRuleCommandInput}
+ * @returns {@link DeleteSamplingRuleCommandOutput}
  * @see {@link DeleteSamplingRuleCommandInput} for command's `input` shape.
  * @see {@link DeleteSamplingRuleCommandOutput} for command's `response` shape.
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -40,11 +47,20 @@ export interface DeleteSamplingRuleCommandOutput extends DeleteSamplingRuleResul
 export declare class DeleteSamplingRuleCommand extends $Command<DeleteSamplingRuleCommandInput, DeleteSamplingRuleCommandOutput, XRayClientResolvedConfig> {
     readonly input: DeleteSamplingRuleCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DeleteSamplingRuleCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSamplingRuleCommandInput, DeleteSamplingRuleCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GetEncryptionConfigRequest, GetEncryptionConfigResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
 /**
+ * @public
+ *
  * The input for {@link GetEncryptionConfigCommand}.
  */
 export interface GetEncryptionConfigCommandInput extends GetEncryptionConfigRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetEncryptionConfigCommand}.
  */
 export interface GetEncryptionConfigCommandOutput extends GetEncryptionConfigResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Retrieves the current encryption configuration for X-Ray data.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetEncryptionConfigCommandOutput extends GetEncryptionConfigRes
  * const response = await client.send(command);
  * ```
  *
+ * @param GetEncryptionConfigCommandInput - {@link GetEncryptionConfigCommandInput}
+ * @returns {@link GetEncryptionConfigCommandOutput}
  * @see {@link GetEncryptionConfigCommandInput} for command's `input` shape.
  * @see {@link GetEncryptionConfigCommandOutput} for command's `response` shape.
  * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
@@ -40,11 +47,20 @@ export interface GetEncryptionConfigCommandOutput extends GetEncryptionConfigRes
 export declare class GetEncryptionConfigCommand extends $Command<GetEncryptionConfigCommandInput, GetEncryptionConfigCommandOutput, XRayClientResolvedConfig> {
     readonly input: GetEncryptionConfigCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetEncryptionConfigCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: XRayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetEncryptionConfigCommandInput, GetEncryptionConfigCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }