@aws-sdk/client-xray

Description

AWS SDK for JavaScript XRay Client for Node.js, Browser and React Native.

Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps
and other data created by processing those traces.

Installing

To install this package, simply type add or install @aws-sdk/client-xray
using your favorite package manager:
- npm install @aws-sdk/client-xray
- yarn add @aws-sdk/client-xray
- pnpm add @aws-sdk/client-xray

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the XRayClient and
the commands you need, for example ListResourcePoliciesCommand:

``js
// ES5 example
const { XRayClient, ListResourcePoliciesCommand } = require("@aws-sdk/client-xray");
`

`ts
// ES6+ example
import { XRayClient, ListResourcePoliciesCommand } from "@aws-sdk/client-xray";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new XRayClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListResourcePoliciesCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-xray";
const client = new AWS.XRay({ region: "REGION" });

// async/await.
try {
const data = await client.listResourcePolicies(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listResourcePolicies(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listResourcePolicies(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-xray` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

BatchGetTraces

Command API Reference / Input / Output

CancelTraceRetrieval

Command API Reference / Input / Output

CreateGroup

Command API Reference / Input / Output

CreateSamplingRule

Command API Reference / Input / Output

DeleteGroup

Command API Reference / Input / Output

DeleteResourcePolicy

Command API Reference / Input / Output

DeleteSamplingRule

Command API Reference / Input / Output

GetEncryptionConfig

Command API Reference / Input / Output

GetGroup

Command API Reference / Input / Output

GetGroups

Command API Reference / Input / Output

GetIndexingRules

Command API Reference / Input / Output

GetInsight

Command API Reference / Input / Output

GetInsightEvents

Command API Reference / Input / Output

GetInsightImpactGraph

Command API Reference / Input / Output

GetInsightSummaries

Command API Reference / Input / Output

GetRetrievedTracesGraph

Command API Reference / Input / Output

GetSamplingRules

Command API Reference / Input / Output

GetSamplingStatisticSummaries

Command API Reference / Input / Output

GetSamplingTargets

Command API Reference / Input / Output

GetServiceGraph

Command API Reference / Input / Output

GetTimeSeriesServiceStatistics

Command API Reference / Input / Output

GetTraceGraph

Command API Reference / Input / Output

GetTraceSegmentDestination

Command API Reference / Input / Output

GetTraceSummaries

Command API Reference / Input / Output

ListResourcePolicies

Command API Reference / Input / Output

ListRetrievedTraces

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

PutEncryptionConfig

Command API Reference / Input / Output

PutResourcePolicy

Command API Reference / Input / Output

PutTelemetryRecords

Command API Reference / Input / Output

PutTraceSegments

Command API Reference / Input / Output

StartTraceRetrieval

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateGroup

Command API Reference / Input / Output

UpdateIndexingRule

Command API Reference / Input / Output

UpdateSamplingRule

Command API Reference / Input / Output

UpdateTraceSegmentDestination

Command API Reference / Input / Output