AWS X-Ray API

The X-Ray API provides access to all X-Ray functionality through the AWS SDK, AWS Command Line Interface, or directly over HTTPS. The X-Ray API Reference documents input parameters for each API action, and the fields and data types that they return.

You can use the AWS SDK to develop programs that use the X-Ray API. The X-Ray console and X-Ray daemon both use the AWS SDK to communicate with X-Ray. The AWS SDK for each language has a reference document for classes and methods that map to X-Ray API actions and types.

AWS SDK References

• Java – AWS SDK for Java

• JavaScript – AWS SDK for JavaScript

• .NET – AWS SDK for .NET

• Ruby – AWS SDK for Ruby

• Go – AWS SDK for Go

• PHP – AWS SDK for PHP

• Python – AWS SDK for Python (Boto)

The AWS Command Line Interface is a command line tool that uses the SDK for Python to call AWS APIs. When you are first learning an AWS API, the AWS CLI provides an easy way to explore the available parameters and view the service output in JSON or text form.

See the AWS CLI Command Reference for details on aws xray subcommands.

Topics

• Using the AWS X-Ray API with the AWS CLI
• Sending trace data to AWS X-Ray
• Getting data from AWS X-Ray
• Configuring sampling, groups, and encryption settings with the AWS X-Ray API
• Using sampling rules with the X-Ray API
• AWS X-Ray segment documents