@aws-sdk/client-xray 3.693.0 → 3.698.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/README.md +64 -0
  2. package/dist-cjs/index.js +506 -24
  3. package/dist-es/XRay.js +16 -0
  4. package/dist-es/commands/CancelTraceRetrievalCommand.js +22 -0
  5. package/dist-es/commands/GetIndexingRulesCommand.js +22 -0
  6. package/dist-es/commands/GetRetrievedTracesGraphCommand.js +22 -0
  7. package/dist-es/commands/GetTraceSegmentDestinationCommand.js +22 -0
  8. package/dist-es/commands/ListRetrievedTracesCommand.js +22 -0
  9. package/dist-es/commands/StartTraceRetrievalCommand.js +22 -0
  10. package/dist-es/commands/UpdateIndexingRuleCommand.js +22 -0
  11. package/dist-es/commands/UpdateTraceSegmentDestinationCommand.js +22 -0
  12. package/dist-es/commands/index.js +8 -0
  13. package/dist-es/models/models_0.js +50 -14
  14. package/dist-es/protocols/Aws_restJson1.js +294 -4
  15. package/dist-types/XRay.d.ts +59 -0
  16. package/dist-types/XRayClient.d.ts +10 -2
  17. package/dist-types/commands/BatchGetTracesCommand.d.ts +4 -1
  18. package/dist-types/commands/CancelTraceRetrievalCommand.d.ts +81 -0
  19. package/dist-types/commands/GetIndexingRulesCommand.d.ts +91 -0
  20. package/dist-types/commands/GetRetrievedTracesGraphCommand.d.ts +185 -0
  21. package/dist-types/commands/GetTraceSegmentDestinationCommand.d.ts +78 -0
  22. package/dist-types/commands/GetTraceSummariesCommand.d.ts +2 -2
  23. package/dist-types/commands/ListRetrievedTracesCommand.d.ts +104 -0
  24. package/dist-types/commands/PutTraceSegmentsCommand.d.ts +14 -4
  25. package/dist-types/commands/StartTraceRetrievalCommand.d.ts +90 -0
  26. package/dist-types/commands/UpdateIndexingRuleCommand.d.ts +98 -0
  27. package/dist-types/commands/UpdateTraceSegmentDestinationCommand.d.ts +80 -0
  28. package/dist-types/commands/index.d.ts +8 -0
  29. package/dist-types/models/models_0.d.ts +826 -256
  30. package/dist-types/protocols/Aws_restJson1.d.ts +72 -0
  31. package/dist-types/ts3.4/XRay.d.ts +139 -0
  32. package/dist-types/ts3.4/XRayClient.d.ts +50 -2
  33. package/dist-types/ts3.4/commands/CancelTraceRetrievalCommand.d.ts +51 -0
  34. package/dist-types/ts3.4/commands/GetIndexingRulesCommand.d.ts +50 -0
  35. package/dist-types/ts3.4/commands/GetRetrievedTracesGraphCommand.d.ts +51 -0
  36. package/dist-types/ts3.4/commands/GetTraceSegmentDestinationCommand.d.ts +51 -0
  37. package/dist-types/ts3.4/commands/ListRetrievedTracesCommand.d.ts +51 -0
  38. package/dist-types/ts3.4/commands/StartTraceRetrievalCommand.d.ts +51 -0
  39. package/dist-types/ts3.4/commands/UpdateIndexingRuleCommand.d.ts +51 -0
  40. package/dist-types/ts3.4/commands/UpdateTraceSegmentDestinationCommand.d.ts +51 -0
  41. package/dist-types/ts3.4/commands/index.d.ts +8 -0
  42. package/dist-types/ts3.4/models/models_0.d.ts +213 -61
  43. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +96 -0
  44. package/package.json +35 -35
@@ -8,6 +8,7 @@ import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration
8
8
  import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
9
9
  import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
10
10
  import { BatchGetTracesCommandInput, BatchGetTracesCommandOutput } from "./commands/BatchGetTracesCommand";
11
+ import { CancelTraceRetrievalCommandInput, CancelTraceRetrievalCommandOutput } from "./commands/CancelTraceRetrievalCommand";
11
12
  import { CreateGroupCommandInput, CreateGroupCommandOutput } from "./commands/CreateGroupCommand";
12
13
  import { CreateSamplingRuleCommandInput, CreateSamplingRuleCommandOutput } from "./commands/CreateSamplingRuleCommand";
13
14
  import { DeleteGroupCommandInput, DeleteGroupCommandOutput } from "./commands/DeleteGroupCommand";
@@ -16,38 +17,45 @@ import { DeleteSamplingRuleCommandInput, DeleteSamplingRuleCommandOutput } from
16
17
  import { GetEncryptionConfigCommandInput, GetEncryptionConfigCommandOutput } from "./commands/GetEncryptionConfigCommand";
17
18
  import { GetGroupCommandInput, GetGroupCommandOutput } from "./commands/GetGroupCommand";
18
19
  import { GetGroupsCommandInput, GetGroupsCommandOutput } from "./commands/GetGroupsCommand";
20
+ import { GetIndexingRulesCommandInput, GetIndexingRulesCommandOutput } from "./commands/GetIndexingRulesCommand";
19
21
  import { GetInsightCommandInput, GetInsightCommandOutput } from "./commands/GetInsightCommand";
20
22
  import { GetInsightEventsCommandInput, GetInsightEventsCommandOutput } from "./commands/GetInsightEventsCommand";
21
23
  import { GetInsightImpactGraphCommandInput, GetInsightImpactGraphCommandOutput } from "./commands/GetInsightImpactGraphCommand";
22
24
  import { GetInsightSummariesCommandInput, GetInsightSummariesCommandOutput } from "./commands/GetInsightSummariesCommand";
25
+ import { GetRetrievedTracesGraphCommandInput, GetRetrievedTracesGraphCommandOutput } from "./commands/GetRetrievedTracesGraphCommand";
23
26
  import { GetSamplingRulesCommandInput, GetSamplingRulesCommandOutput } from "./commands/GetSamplingRulesCommand";
24
27
  import { GetSamplingStatisticSummariesCommandInput, GetSamplingStatisticSummariesCommandOutput } from "./commands/GetSamplingStatisticSummariesCommand";
25
28
  import { GetSamplingTargetsCommandInput, GetSamplingTargetsCommandOutput } from "./commands/GetSamplingTargetsCommand";
26
29
  import { GetServiceGraphCommandInput, GetServiceGraphCommandOutput } from "./commands/GetServiceGraphCommand";
27
30
  import { GetTimeSeriesServiceStatisticsCommandInput, GetTimeSeriesServiceStatisticsCommandOutput } from "./commands/GetTimeSeriesServiceStatisticsCommand";
28
31
  import { GetTraceGraphCommandInput, GetTraceGraphCommandOutput } from "./commands/GetTraceGraphCommand";
32
+ import { GetTraceSegmentDestinationCommandInput, GetTraceSegmentDestinationCommandOutput } from "./commands/GetTraceSegmentDestinationCommand";
29
33
  import { GetTraceSummariesCommandInput, GetTraceSummariesCommandOutput } from "./commands/GetTraceSummariesCommand";
30
34
  import { ListResourcePoliciesCommandInput, ListResourcePoliciesCommandOutput } from "./commands/ListResourcePoliciesCommand";
35
+ import { ListRetrievedTracesCommandInput, ListRetrievedTracesCommandOutput } from "./commands/ListRetrievedTracesCommand";
31
36
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
32
37
  import { PutEncryptionConfigCommandInput, PutEncryptionConfigCommandOutput } from "./commands/PutEncryptionConfigCommand";
33
38
  import { PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput } from "./commands/PutResourcePolicyCommand";
34
39
  import { PutTelemetryRecordsCommandInput, PutTelemetryRecordsCommandOutput } from "./commands/PutTelemetryRecordsCommand";
35
40
  import { PutTraceSegmentsCommandInput, PutTraceSegmentsCommandOutput } from "./commands/PutTraceSegmentsCommand";
41
+ import { StartTraceRetrievalCommandInput, StartTraceRetrievalCommandOutput } from "./commands/StartTraceRetrievalCommand";
36
42
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
37
43
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
38
44
  import { UpdateGroupCommandInput, UpdateGroupCommandOutput } from "./commands/UpdateGroupCommand";
45
+ import { UpdateIndexingRuleCommandInput, UpdateIndexingRuleCommandOutput } from "./commands/UpdateIndexingRuleCommand";
39
46
  import { UpdateSamplingRuleCommandInput, UpdateSamplingRuleCommandOutput } from "./commands/UpdateSamplingRuleCommand";
47
+ import { UpdateTraceSegmentDestinationCommandInput, UpdateTraceSegmentDestinationCommandOutput } from "./commands/UpdateTraceSegmentDestinationCommand";
40
48
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
41
49
  import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
42
50
  export { __Client };
43
51
  /**
44
52
  * @public
45
53
  */
46
- 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;
54
+ export type ServiceInputTypes = BatchGetTracesCommandInput | CancelTraceRetrievalCommandInput | CreateGroupCommandInput | CreateSamplingRuleCommandInput | DeleteGroupCommandInput | DeleteResourcePolicyCommandInput | DeleteSamplingRuleCommandInput | GetEncryptionConfigCommandInput | GetGroupCommandInput | GetGroupsCommandInput | GetIndexingRulesCommandInput | GetInsightCommandInput | GetInsightEventsCommandInput | GetInsightImpactGraphCommandInput | GetInsightSummariesCommandInput | GetRetrievedTracesGraphCommandInput | GetSamplingRulesCommandInput | GetSamplingStatisticSummariesCommandInput | GetSamplingTargetsCommandInput | GetServiceGraphCommandInput | GetTimeSeriesServiceStatisticsCommandInput | GetTraceGraphCommandInput | GetTraceSegmentDestinationCommandInput | GetTraceSummariesCommandInput | ListResourcePoliciesCommandInput | ListRetrievedTracesCommandInput | ListTagsForResourceCommandInput | PutEncryptionConfigCommandInput | PutResourcePolicyCommandInput | PutTelemetryRecordsCommandInput | PutTraceSegmentsCommandInput | StartTraceRetrievalCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateGroupCommandInput | UpdateIndexingRuleCommandInput | UpdateSamplingRuleCommandInput | UpdateTraceSegmentDestinationCommandInput;
47
55
  /**
48
56
  * @public
49
57
  */
50
- 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;
58
+ export type ServiceOutputTypes = BatchGetTracesCommandOutput | CancelTraceRetrievalCommandOutput | CreateGroupCommandOutput | CreateSamplingRuleCommandOutput | DeleteGroupCommandOutput | DeleteResourcePolicyCommandOutput | DeleteSamplingRuleCommandOutput | GetEncryptionConfigCommandOutput | GetGroupCommandOutput | GetGroupsCommandOutput | GetIndexingRulesCommandOutput | GetInsightCommandOutput | GetInsightEventsCommandOutput | GetInsightImpactGraphCommandOutput | GetInsightSummariesCommandOutput | GetRetrievedTracesGraphCommandOutput | GetSamplingRulesCommandOutput | GetSamplingStatisticSummariesCommandOutput | GetSamplingTargetsCommandOutput | GetServiceGraphCommandOutput | GetTimeSeriesServiceStatisticsCommandOutput | GetTraceGraphCommandOutput | GetTraceSegmentDestinationCommandOutput | GetTraceSummariesCommandOutput | ListResourcePoliciesCommandOutput | ListRetrievedTracesCommandOutput | ListTagsForResourceCommandOutput | PutEncryptionConfigCommandOutput | PutResourcePolicyCommandOutput | PutTelemetryRecordsCommandOutput | PutTraceSegmentsCommandOutput | StartTraceRetrievalCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateGroupCommandOutput | UpdateIndexingRuleCommandOutput | UpdateSamplingRuleCommandOutput | UpdateTraceSegmentDestinationCommandOutput;
51
59
  /**
52
60
  * @public
53
61
  */
@@ -27,7 +27,10 @@ declare const BatchGetTracesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Retrieves a list of traces specified by ID. Each trace is a collection of segment
30
+ * <note>
31
+ * <p>You cannot find traces through this API if Transaction Search is enabled since trace is not indexed in X-Ray.</p>
32
+ * </note>
33
+ * <p>Retrieves a list of traces specified by ID. Each trace is a collection of segment
31
34
  * documents that originates from a single request. Use <code>GetTraceSummaries</code> to get a
32
35
  * list of trace IDs.</p>
33
36
  * @example
@@ -0,0 +1,81 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { CancelTraceRetrievalRequest, CancelTraceRetrievalResult } from "../models/models_0";
4
+ import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link CancelTraceRetrievalCommand}.
14
+ */
15
+ export interface CancelTraceRetrievalCommandInput extends CancelTraceRetrievalRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CancelTraceRetrievalCommand}.
21
+ */
22
+ export interface CancelTraceRetrievalCommandOutput extends CancelTraceRetrievalResult, __MetadataBearer {
23
+ }
24
+ declare const CancelTraceRetrievalCommand_base: {
25
+ new (input: CancelTraceRetrievalCommandInput): import("@smithy/smithy-client").CommandImpl<CancelTraceRetrievalCommandInput, CancelTraceRetrievalCommandOutput, XRayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: CancelTraceRetrievalCommandInput): import("@smithy/smithy-client").CommandImpl<CancelTraceRetrievalCommandInput, CancelTraceRetrievalCommandOutput, XRayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>
31
+ * Cancels an ongoing trace retrieval job initiated by <code>StartTraceRetrieval</code> using the provided <code>RetrievalToken</code>. A successful cancellation will return an HTTP 200 response.
32
+ * </p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { XRayClient, CancelTraceRetrievalCommand } from "@aws-sdk/client-xray"; // ES Modules import
37
+ * // const { XRayClient, CancelTraceRetrievalCommand } = require("@aws-sdk/client-xray"); // CommonJS import
38
+ * const client = new XRayClient(config);
39
+ * const input = { // CancelTraceRetrievalRequest
40
+ * RetrievalToken: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new CancelTraceRetrievalCommand(input);
43
+ * const response = await client.send(command);
44
+ * // {};
45
+ *
46
+ * ```
47
+ *
48
+ * @param CancelTraceRetrievalCommandInput - {@link CancelTraceRetrievalCommandInput}
49
+ * @returns {@link CancelTraceRetrievalCommandOutput}
50
+ * @see {@link CancelTraceRetrievalCommandInput} for command's `input` shape.
51
+ * @see {@link CancelTraceRetrievalCommandOutput} for command's `response` shape.
52
+ * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
53
+ *
54
+ * @throws {@link InvalidRequestException} (client fault)
55
+ * <p>The request is missing required parameters or has invalid parameters.</p>
56
+ *
57
+ * @throws {@link ResourceNotFoundException} (client fault)
58
+ * <p>The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is
59
+ * correct.</p>
60
+ *
61
+ * @throws {@link ThrottledException} (client fault)
62
+ * <p>The request exceeds the maximum number of requests per second.</p>
63
+ *
64
+ * @throws {@link XRayServiceException}
65
+ * <p>Base exception class for all service exceptions from XRay service.</p>
66
+ *
67
+ * @public
68
+ */
69
+ export declare class CancelTraceRetrievalCommand extends CancelTraceRetrievalCommand_base {
70
+ /** @internal type navigation helper, not in runtime. */
71
+ protected static __types: {
72
+ api: {
73
+ input: CancelTraceRetrievalRequest;
74
+ output: {};
75
+ };
76
+ sdk: {
77
+ input: CancelTraceRetrievalCommandInput;
78
+ output: CancelTraceRetrievalCommandOutput;
79
+ };
80
+ };
81
+ }
@@ -0,0 +1,91 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { GetIndexingRulesRequest, GetIndexingRulesResult } from "../models/models_0";
4
+ import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetIndexingRulesCommand}.
14
+ */
15
+ export interface GetIndexingRulesCommandInput extends GetIndexingRulesRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetIndexingRulesCommand}.
21
+ */
22
+ export interface GetIndexingRulesCommandOutput extends GetIndexingRulesResult, __MetadataBearer {
23
+ }
24
+ declare const GetIndexingRulesCommand_base: {
25
+ new (input: GetIndexingRulesCommandInput): import("@smithy/smithy-client").CommandImpl<GetIndexingRulesCommandInput, GetIndexingRulesCommandOutput, XRayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [GetIndexingRulesCommandInput]): import("@smithy/smithy-client").CommandImpl<GetIndexingRulesCommandInput, GetIndexingRulesCommandOutput, XRayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>
31
+ * Retrieves all indexing rules.</p>
32
+ * <p>Indexing rules are used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html">Transaction Search</a>.</p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { XRayClient, GetIndexingRulesCommand } from "@aws-sdk/client-xray"; // ES Modules import
37
+ * // const { XRayClient, GetIndexingRulesCommand } = require("@aws-sdk/client-xray"); // CommonJS import
38
+ * const client = new XRayClient(config);
39
+ * const input = { // GetIndexingRulesRequest
40
+ * NextToken: "STRING_VALUE",
41
+ * };
42
+ * const command = new GetIndexingRulesCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // GetIndexingRulesResult
45
+ * // IndexingRules: [ // IndexingRuleList
46
+ * // { // IndexingRule
47
+ * // Name: "STRING_VALUE",
48
+ * // ModifiedAt: new Date("TIMESTAMP"),
49
+ * // Rule: { // IndexingRuleValue Union: only one key present
50
+ * // Probabilistic: { // ProbabilisticRuleValue
51
+ * // DesiredSamplingPercentage: Number("double"), // required
52
+ * // ActualSamplingPercentage: Number("double"),
53
+ * // },
54
+ * // },
55
+ * // },
56
+ * // ],
57
+ * // NextToken: "STRING_VALUE",
58
+ * // };
59
+ *
60
+ * ```
61
+ *
62
+ * @param GetIndexingRulesCommandInput - {@link GetIndexingRulesCommandInput}
63
+ * @returns {@link GetIndexingRulesCommandOutput}
64
+ * @see {@link GetIndexingRulesCommandInput} for command's `input` shape.
65
+ * @see {@link GetIndexingRulesCommandOutput} for command's `response` shape.
66
+ * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
67
+ *
68
+ * @throws {@link InvalidRequestException} (client fault)
69
+ * <p>The request is missing required parameters or has invalid parameters.</p>
70
+ *
71
+ * @throws {@link ThrottledException} (client fault)
72
+ * <p>The request exceeds the maximum number of requests per second.</p>
73
+ *
74
+ * @throws {@link XRayServiceException}
75
+ * <p>Base exception class for all service exceptions from XRay service.</p>
76
+ *
77
+ * @public
78
+ */
79
+ export declare class GetIndexingRulesCommand extends GetIndexingRulesCommand_base {
80
+ /** @internal type navigation helper, not in runtime. */
81
+ protected static __types: {
82
+ api: {
83
+ input: GetIndexingRulesRequest;
84
+ output: GetIndexingRulesResult;
85
+ };
86
+ sdk: {
87
+ input: GetIndexingRulesCommandInput;
88
+ output: GetIndexingRulesCommandOutput;
89
+ };
90
+ };
91
+ }
@@ -0,0 +1,185 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { GetRetrievedTracesGraphRequest, GetRetrievedTracesGraphResult } from "../models/models_0";
4
+ import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetRetrievedTracesGraphCommand}.
14
+ */
15
+ export interface GetRetrievedTracesGraphCommandInput extends GetRetrievedTracesGraphRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetRetrievedTracesGraphCommand}.
21
+ */
22
+ export interface GetRetrievedTracesGraphCommandOutput extends GetRetrievedTracesGraphResult, __MetadataBearer {
23
+ }
24
+ declare const GetRetrievedTracesGraphCommand_base: {
25
+ new (input: GetRetrievedTracesGraphCommandInput): import("@smithy/smithy-client").CommandImpl<GetRetrievedTracesGraphCommandInput, GetRetrievedTracesGraphCommandOutput, XRayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetRetrievedTracesGraphCommandInput): import("@smithy/smithy-client").CommandImpl<GetRetrievedTracesGraphCommandInput, GetRetrievedTracesGraphCommandOutput, XRayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>
31
+ * Retrieves a service graph for traces based on the specified <code>RetrievalToken</code> from the CloudWatch log group generated by Transaction Search. This API does not initiate a retrieval job. You must first execute <code>StartTraceRetrieval</code> to obtain the required <code>RetrievalToken</code>.
32
+ * </p>
33
+ * <p>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.</p>
34
+ * <p>The response is empty until the <code>RetrievalStatus</code> is <i>COMPLETE</i>. Retry the request after the status changes from <i>RUNNING</i> or <i>SCHEDULED</i> to <i>COMPLETE</i> to access the full service graph.</p>
35
+ * <p>
36
+ * When CloudWatch log is the destination, this API can support cross-account observability and service graph retrieval across linked accounts.</p>
37
+ * <p>For retrieving graphs from X-Ray directly as opposed to the Transaction-Search Log group, see <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetTraceGraph.html">GetTraceGraph</a>.</p>
38
+ * @example
39
+ * Use a bare-bones client and the command you need to make an API call.
40
+ * ```javascript
41
+ * import { XRayClient, GetRetrievedTracesGraphCommand } from "@aws-sdk/client-xray"; // ES Modules import
42
+ * // const { XRayClient, GetRetrievedTracesGraphCommand } = require("@aws-sdk/client-xray"); // CommonJS import
43
+ * const client = new XRayClient(config);
44
+ * const input = { // GetRetrievedTracesGraphRequest
45
+ * RetrievalToken: "STRING_VALUE", // required
46
+ * NextToken: "STRING_VALUE",
47
+ * };
48
+ * const command = new GetRetrievedTracesGraphCommand(input);
49
+ * const response = await client.send(command);
50
+ * // { // GetRetrievedTracesGraphResult
51
+ * // RetrievalStatus: "SCHEDULED" || "RUNNING" || "COMPLETE" || "FAILED" || "CANCELLED" || "TIMEOUT",
52
+ * // Services: [ // RetrievedServicesList
53
+ * // { // RetrievedService
54
+ * // Service: { // Service
55
+ * // ReferenceId: Number("int"),
56
+ * // Name: "STRING_VALUE",
57
+ * // Names: [ // ServiceNames
58
+ * // "STRING_VALUE",
59
+ * // ],
60
+ * // Root: true || false,
61
+ * // AccountId: "STRING_VALUE",
62
+ * // Type: "STRING_VALUE",
63
+ * // State: "STRING_VALUE",
64
+ * // StartTime: new Date("TIMESTAMP"),
65
+ * // EndTime: new Date("TIMESTAMP"),
66
+ * // Edges: [ // EdgeList
67
+ * // { // Edge
68
+ * // ReferenceId: Number("int"),
69
+ * // StartTime: new Date("TIMESTAMP"),
70
+ * // EndTime: new Date("TIMESTAMP"),
71
+ * // SummaryStatistics: { // EdgeStatistics
72
+ * // OkCount: Number("long"),
73
+ * // ErrorStatistics: { // ErrorStatistics
74
+ * // ThrottleCount: Number("long"),
75
+ * // OtherCount: Number("long"),
76
+ * // TotalCount: Number("long"),
77
+ * // },
78
+ * // FaultStatistics: { // FaultStatistics
79
+ * // OtherCount: Number("long"),
80
+ * // TotalCount: Number("long"),
81
+ * // },
82
+ * // TotalCount: Number("long"),
83
+ * // TotalResponseTime: Number("double"),
84
+ * // },
85
+ * // ResponseTimeHistogram: [ // Histogram
86
+ * // { // HistogramEntry
87
+ * // Value: Number("double"),
88
+ * // Count: Number("int"),
89
+ * // },
90
+ * // ],
91
+ * // Aliases: [ // AliasList
92
+ * // { // Alias
93
+ * // Name: "STRING_VALUE",
94
+ * // Names: [ // AliasNames
95
+ * // "STRING_VALUE",
96
+ * // ],
97
+ * // Type: "STRING_VALUE",
98
+ * // },
99
+ * // ],
100
+ * // EdgeType: "STRING_VALUE",
101
+ * // ReceivedEventAgeHistogram: [
102
+ * // {
103
+ * // Value: Number("double"),
104
+ * // Count: Number("int"),
105
+ * // },
106
+ * // ],
107
+ * // },
108
+ * // ],
109
+ * // SummaryStatistics: { // ServiceStatistics
110
+ * // OkCount: Number("long"),
111
+ * // ErrorStatistics: {
112
+ * // ThrottleCount: Number("long"),
113
+ * // OtherCount: Number("long"),
114
+ * // TotalCount: Number("long"),
115
+ * // },
116
+ * // FaultStatistics: {
117
+ * // OtherCount: Number("long"),
118
+ * // TotalCount: Number("long"),
119
+ * // },
120
+ * // TotalCount: Number("long"),
121
+ * // TotalResponseTime: Number("double"),
122
+ * // },
123
+ * // DurationHistogram: [
124
+ * // {
125
+ * // Value: Number("double"),
126
+ * // Count: Number("int"),
127
+ * // },
128
+ * // ],
129
+ * // ResponseTimeHistogram: [
130
+ * // {
131
+ * // Value: Number("double"),
132
+ * // Count: Number("int"),
133
+ * // },
134
+ * // ],
135
+ * // },
136
+ * // Links: [ // LinksList
137
+ * // { // GraphLink
138
+ * // ReferenceType: "STRING_VALUE",
139
+ * // SourceTraceId: "STRING_VALUE",
140
+ * // DestinationTraceIds: [ // TraceIdList
141
+ * // "STRING_VALUE",
142
+ * // ],
143
+ * // },
144
+ * // ],
145
+ * // },
146
+ * // ],
147
+ * // NextToken: "STRING_VALUE",
148
+ * // };
149
+ *
150
+ * ```
151
+ *
152
+ * @param GetRetrievedTracesGraphCommandInput - {@link GetRetrievedTracesGraphCommandInput}
153
+ * @returns {@link GetRetrievedTracesGraphCommandOutput}
154
+ * @see {@link GetRetrievedTracesGraphCommandInput} for command's `input` shape.
155
+ * @see {@link GetRetrievedTracesGraphCommandOutput} for command's `response` shape.
156
+ * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
157
+ *
158
+ * @throws {@link InvalidRequestException} (client fault)
159
+ * <p>The request is missing required parameters or has invalid parameters.</p>
160
+ *
161
+ * @throws {@link ResourceNotFoundException} (client fault)
162
+ * <p>The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is
163
+ * correct.</p>
164
+ *
165
+ * @throws {@link ThrottledException} (client fault)
166
+ * <p>The request exceeds the maximum number of requests per second.</p>
167
+ *
168
+ * @throws {@link XRayServiceException}
169
+ * <p>Base exception class for all service exceptions from XRay service.</p>
170
+ *
171
+ * @public
172
+ */
173
+ export declare class GetRetrievedTracesGraphCommand extends GetRetrievedTracesGraphCommand_base {
174
+ /** @internal type navigation helper, not in runtime. */
175
+ protected static __types: {
176
+ api: {
177
+ input: GetRetrievedTracesGraphRequest;
178
+ output: GetRetrievedTracesGraphResult;
179
+ };
180
+ sdk: {
181
+ input: GetRetrievedTracesGraphCommandInput;
182
+ output: GetRetrievedTracesGraphCommandOutput;
183
+ };
184
+ };
185
+ }
@@ -0,0 +1,78 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { GetTraceSegmentDestinationRequest, GetTraceSegmentDestinationResult } from "../models/models_0";
4
+ import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetTraceSegmentDestinationCommand}.
14
+ */
15
+ export interface GetTraceSegmentDestinationCommandInput extends GetTraceSegmentDestinationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetTraceSegmentDestinationCommand}.
21
+ */
22
+ export interface GetTraceSegmentDestinationCommandOutput extends GetTraceSegmentDestinationResult, __MetadataBearer {
23
+ }
24
+ declare const GetTraceSegmentDestinationCommand_base: {
25
+ new (input: GetTraceSegmentDestinationCommandInput): import("@smithy/smithy-client").CommandImpl<GetTraceSegmentDestinationCommandInput, GetTraceSegmentDestinationCommandOutput, XRayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [GetTraceSegmentDestinationCommandInput]): import("@smithy/smithy-client").CommandImpl<GetTraceSegmentDestinationCommandInput, GetTraceSegmentDestinationCommandOutput, XRayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>
31
+ * Retrieves the current destination of data sent to <code>PutTraceSegments</code> and <i>OpenTelemetry</i> API. The Transaction Search feature requires a CloudWatchLogs destination. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html">Transaction Search</a> and <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-OpenTelemetry-Sections.html">OpenTelemetry</a>.
32
+ * </p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { XRayClient, GetTraceSegmentDestinationCommand } from "@aws-sdk/client-xray"; // ES Modules import
37
+ * // const { XRayClient, GetTraceSegmentDestinationCommand } = require("@aws-sdk/client-xray"); // CommonJS import
38
+ * const client = new XRayClient(config);
39
+ * const input = {};
40
+ * const command = new GetTraceSegmentDestinationCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetTraceSegmentDestinationResult
43
+ * // Destination: "XRay" || "CloudWatchLogs",
44
+ * // Status: "PENDING" || "ACTIVE",
45
+ * // };
46
+ *
47
+ * ```
48
+ *
49
+ * @param GetTraceSegmentDestinationCommandInput - {@link GetTraceSegmentDestinationCommandInput}
50
+ * @returns {@link GetTraceSegmentDestinationCommandOutput}
51
+ * @see {@link GetTraceSegmentDestinationCommandInput} for command's `input` shape.
52
+ * @see {@link GetTraceSegmentDestinationCommandOutput} for command's `response` shape.
53
+ * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
54
+ *
55
+ * @throws {@link InvalidRequestException} (client fault)
56
+ * <p>The request is missing required parameters or has invalid parameters.</p>
57
+ *
58
+ * @throws {@link ThrottledException} (client fault)
59
+ * <p>The request exceeds the maximum number of requests per second.</p>
60
+ *
61
+ * @throws {@link XRayServiceException}
62
+ * <p>Base exception class for all service exceptions from XRay service.</p>
63
+ *
64
+ * @public
65
+ */
66
+ export declare class GetTraceSegmentDestinationCommand extends GetTraceSegmentDestinationCommand_base {
67
+ /** @internal type navigation helper, not in runtime. */
68
+ protected static __types: {
69
+ api: {
70
+ input: {};
71
+ output: GetTraceSegmentDestinationResult;
72
+ };
73
+ sdk: {
74
+ input: GetTraceSegmentDestinationCommandInput;
75
+ output: GetTraceSegmentDestinationCommandOutput;
76
+ };
77
+ };
78
+ }
@@ -42,8 +42,8 @@ declare const GetTraceSummariesCommand_base: {
42
42
  * <code>annotation.account = "12345"</code>
43
43
  * </p>
44
44
  * <p>For a full list of indexed fields and keywords that you can use in filter expressions,
45
- * see <a href="https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html">Using Filter
46
- * Expressions</a> in the <i>Amazon Web Services X-Ray Developer Guide</i>.</p>
45
+ * see <a href="https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-console.html#xray-console-filters">Use filter
46
+ * expressions</a> in the <i>Amazon Web Services X-Ray Developer Guide</i>.</p>
47
47
  * @example
48
48
  * Use a bare-bones client and the command you need to make an API call.
49
49
  * ```javascript
@@ -0,0 +1,104 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ListRetrievedTracesRequest, ListRetrievedTracesResult } from "../models/models_0";
4
+ import { ServiceInputTypes, ServiceOutputTypes, XRayClientResolvedConfig } from "../XRayClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListRetrievedTracesCommand}.
14
+ */
15
+ export interface ListRetrievedTracesCommandInput extends ListRetrievedTracesRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListRetrievedTracesCommand}.
21
+ */
22
+ export interface ListRetrievedTracesCommandOutput extends ListRetrievedTracesResult, __MetadataBearer {
23
+ }
24
+ declare const ListRetrievedTracesCommand_base: {
25
+ new (input: ListRetrievedTracesCommandInput): import("@smithy/smithy-client").CommandImpl<ListRetrievedTracesCommandInput, ListRetrievedTracesCommandOutput, XRayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ListRetrievedTracesCommandInput): import("@smithy/smithy-client").CommandImpl<ListRetrievedTracesCommandInput, ListRetrievedTracesCommandOutput, XRayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>
31
+ * Retrieves a list of traces for a given <code>RetrievalToken</code> from the CloudWatch log group generated by Transaction Search. For information on what each trace returns, see <a href="https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html">BatchGetTraces</a>.
32
+ * </p>
33
+ * <p>This API does not initiate a retrieval job. To start a trace retrieval, use <code>StartTraceRetrieval</code>, which generates the required <code>RetrievalToken</code>.</p>
34
+ * <p>
35
+ * When the <code>RetrievalStatus</code> is not <i>COMPLETE</i>, the API will return an empty response. Retry the request once the retrieval has completed to access the full list of traces.</p>
36
+ * <p>For cross-account observability, this API can retrieve traces from linked accounts when CloudWatch log is the destination across relevant accounts. For more details, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
37
+ * <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>
38
+ * @example
39
+ * Use a bare-bones client and the command you need to make an API call.
40
+ * ```javascript
41
+ * import { XRayClient, ListRetrievedTracesCommand } from "@aws-sdk/client-xray"; // ES Modules import
42
+ * // const { XRayClient, ListRetrievedTracesCommand } = require("@aws-sdk/client-xray"); // CommonJS import
43
+ * const client = new XRayClient(config);
44
+ * const input = { // ListRetrievedTracesRequest
45
+ * RetrievalToken: "STRING_VALUE", // required
46
+ * TraceFormat: "XRAY" || "OTEL",
47
+ * NextToken: "STRING_VALUE",
48
+ * };
49
+ * const command = new ListRetrievedTracesCommand(input);
50
+ * const response = await client.send(command);
51
+ * // { // ListRetrievedTracesResult
52
+ * // RetrievalStatus: "SCHEDULED" || "RUNNING" || "COMPLETE" || "FAILED" || "CANCELLED" || "TIMEOUT",
53
+ * // TraceFormat: "XRAY" || "OTEL",
54
+ * // Traces: [ // TraceSpanList
55
+ * // { // RetrievedTrace
56
+ * // Id: "STRING_VALUE",
57
+ * // Duration: Number("double"),
58
+ * // Spans: [ // SpanList
59
+ * // { // Span
60
+ * // Id: "STRING_VALUE",
61
+ * // Document: "STRING_VALUE",
62
+ * // },
63
+ * // ],
64
+ * // },
65
+ * // ],
66
+ * // NextToken: "STRING_VALUE",
67
+ * // };
68
+ *
69
+ * ```
70
+ *
71
+ * @param ListRetrievedTracesCommandInput - {@link ListRetrievedTracesCommandInput}
72
+ * @returns {@link ListRetrievedTracesCommandOutput}
73
+ * @see {@link ListRetrievedTracesCommandInput} for command's `input` shape.
74
+ * @see {@link ListRetrievedTracesCommandOutput} for command's `response` shape.
75
+ * @see {@link XRayClientResolvedConfig | config} for XRayClient's `config` shape.
76
+ *
77
+ * @throws {@link InvalidRequestException} (client fault)
78
+ * <p>The request is missing required parameters or has invalid parameters.</p>
79
+ *
80
+ * @throws {@link ResourceNotFoundException} (client fault)
81
+ * <p>The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is
82
+ * correct.</p>
83
+ *
84
+ * @throws {@link ThrottledException} (client fault)
85
+ * <p>The request exceeds the maximum number of requests per second.</p>
86
+ *
87
+ * @throws {@link XRayServiceException}
88
+ * <p>Base exception class for all service exceptions from XRay service.</p>
89
+ *
90
+ * @public
91
+ */
92
+ export declare class ListRetrievedTracesCommand extends ListRetrievedTracesCommand_base {
93
+ /** @internal type navigation helper, not in runtime. */
94
+ protected static __types: {
95
+ api: {
96
+ input: ListRetrievedTracesRequest;
97
+ output: ListRetrievedTracesResult;
98
+ };
99
+ sdk: {
100
+ input: ListRetrievedTracesCommandInput;
101
+ output: ListRetrievedTracesCommandOutput;
102
+ };
103
+ };
104
+ }