UpdateTraceSegmentDestination - Amazon X-Ray
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

UpdateTraceSegmentDestination

Modifies the destination of data sent to PutTraceSegments. The Transaction Search feature requires the CloudWatchLogs destination. For more information, see Transaction Search.

Request Syntax

POST /UpdateTraceSegmentDestination HTTP/1.1 Content-type: application/json { "Destination": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Destination

The configured destination of trace segments.

Type: String

Valid Values: XRay | CloudWatchLogs

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Destination": "string", "Status": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Destination

The destination of the trace segments.

Type: String

Valid Values: XRay | CloudWatchLogs

Status

The status of the update.

Type: String

Valid Values: PENDING | ACTIVE

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidRequestException

The request is missing required parameters or has invalid parameters.

HTTP Status Code: 400

ThrottledException

The request exceeds the maximum number of requests per second.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: