"documentation":"<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>"
"documentation":"<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 AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.</p>"
},
"GetTraceGraph":{
"name":"GetTraceGraph",
"http":{
"method":"POST",
"requestUri":"/TraceGraph"
},
"input":{"shape":"GetTraceGraphRequest"},
"output":{"shape":"GetTraceGraphResult"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottledException"}
],
"documentation":"<p>Retrieves a service graph for one or more specific trace IDs.</p>"
"documentation":"<p>Retrieves IDs and metadata 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> <p>A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through <code>api.example.com</code>:</p> <p> <code>service(\"api.example.com\")</code> </p> <p>This filter expression finds traces that have an annotation named <code>account</code> with the value <code>12345</code>:</p> <p> <code>annotation.account = \"12345\"</code> </p> <p>For a full list of indexed fields and keywords that you can use in filter expressions, see <a href=\"http://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html\">Using Filter Expressions</a> in the <i>AWS X-Ray Developer Guide</i>.</p>"
"documentation":"<p>Uploads segment documents to AWS X-Ray. The X-Ray SDK 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> <p>Segments must include the following fields. For the full segment document schema, see <a href=\"https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html\">AWS X-Ray Segment Documents</a> in the <i>AWS X-Ray Developer Guide</i>.</p> <p class=\"title\"> <b>Required Segment Document Fields</b> </p> <ul> <li> <p> <code>name</code> - The name of the service that handled the request.</p> </li> <li> <p> <code>id</code> - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits.</p> </li> <li> <p> <code>trace_id</code> - A unique identifier that connects all segments and subsegments originating from a single client request.</p> </li> <li> <p> <code>start_time</code> - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, <code>1480615200.010</code> or <code>1.480615200010E9</code>.</p> </li> <li> <p> <code>end_time</code> - Time the segment or subsegment was closed. For example, <code>1480615200.090</code> or <code>1.480615200090E9</code>. Specify either an <code>end_time</code> or <code>in_progress</code>.</p> </li> <li> <p> <code>in_progress</code> - Set to <code>true</code> instead of specifying an <code>end_time</code> to record that a segment has been started, but is not complete. Send an in progress segment when your application receives a request that will take a long time to serve, to trace the fact that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment.</p> </li> </ul> <p>A <code>trace_id</code> consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes:</p> <p class=\"title\"> <b>Trace ID Format</b> </p> <ul> <li> <p>The version number, i.e. <code>1</code>.</p> </li> <li> <p>The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is <code>1480615200</code> seconds, or <code>58406520</code> in hexadecimal.</p> </li> <li> <p>A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.</p> </li> </ul>"
"documentation":"<p>The ID of the customer master key (CMK) used for encryption, if applicable.</p>"
},
"Status":{
"shape":"EncryptionStatus",
"documentation":"<p>The encryption status. After modifying encryption configuration with <a>PutEncryptionConfig</a>, the status can be <code>UPDATING</code> for up to one hour before X-Ray starts encrypting data with the new key.</p>"
},
"Type":{
"shape":"EncryptionType",
"documentation":"<p>The type of encryption. Set to <code>KMS</code> for encryption with CMKs. Set to <code>NONE</code> for default encryption.</p>"
}
},
"documentation":"<p>A configuration document that specifies encryption configuration settings.</p>"
"documentation":"<p>If the requested time frame contained more than one page of results, you can use this token to retrieve the next page. The first page contains the most most recent results, closest to the end of the time frame.</p>"
}
}
},
"Histogram":{
"type":"list",
"member":{"shape":"HistogramEntry"}
},
"HistogramEntry":{
"type":"structure",
"members":{
"Value":{
"shape":"Double",
"documentation":"<p>The value of the entry.</p>"
},
"Count":{
"shape":"Integer",
"documentation":"<p>The prevalence of the entry.</p>"
}
},
"documentation":"<p>An entry in a histogram for a statistic. A histogram maps the range of observed values on the X axis, and the prevalence of each value on the Y axis.</p>"
"documentation":"<p>An AWS KMS customer master key (CMK) in one of the following formats:</p> <ul> <li> <p> <b>Alias</b> - The name of the key. For example, <code>alias/MyKey</code>.</p> </li> <li> <p> <b>Key ID</b> - The KMS key ID of the key. For example, <code>ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>.</p> </li> <li> <p> <b>ARN</b> - The full Amazon Resource Name of the key ID or alias. For example, <code>arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>. Use this format to specify a key in a different account.</p> </li> </ul> <p>Omit this key if you set <code>Type</code> to <code>NONE</code>.</p>"
},
"Type":{
"shape":"EncryptionType",
"documentation":"<p>The type of encryption. Set to <code>KMS</code> to use your own key for encryption. Set to <code>NONE</code> for default encryption.</p>"
}
}
},
"PutEncryptionConfigResult":{
"type":"structure",
"members":{
"EncryptionConfig":{
"shape":"EncryptionConfig",
"documentation":"<p>The new encryption configuration.</p>"
"documentation":"<p>A segment from a trace that has been ingested by the X-Ray service. The segment can be compiled from documents uploaded with <a>PutTraceSegments</a>, or an <code>inferred</code> segment for a downstream service, generated from a subsegment sent by the service that called it.</p> <p>For the full segment document schema, see <a href=\"https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html\">AWS X-Ray Segment Documents</a> in the <i>AWS X-Ray Developer Guide</i>.</p>"
"documentation":"<p>Identifier for the service. Unique within the service map.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>The canonical name of the service.</p>"
},
"Names":{
"shape":"ServiceNames",
"documentation":"<p>A list of names for the service, including the canonical name.</p>"
},
"Root":{
"shape":"NullableBoolean",
"documentation":"<p>Indicates that the service was the first service to process a request.</p>"
},
"AccountId":{
"shape":"String",
"documentation":"<p>Identifier of the AWS account in which the service runs.</p>"
},
"Type":{
"shape":"String",
"documentation":"<p>The type of service.</p> <ul> <li> <p>AWS Resource - The type of an AWS resource. For example, <code>AWS::EC2::Instance</code> for a application running on Amazon EC2 or <code>AWS::DynamoDB::Table</code> for an Amazon DynamoDB table that the application used.</p> </li> <li> <p>AWS Service - The type of an AWS service. For example, <code>AWS::DynamoDB</code> for downstream calls to Amazon DynamoDB that didn't target a specific table.</p> </li> <li> <p> <code>client</code> - Represents the clients that sent requests to a root service.</p> </li> <li> <p> <code>remote</code> - A downstream service of indeterminate type.</p> </li> </ul>"
},
"State":{
"shape":"String",
"documentation":"<p>The service's state.</p>"
},
"StartTime":{
"shape":"Timestamp",
"documentation":"<p>The start time of the first segment that the service generated.</p>"
},
"EndTime":{
"shape":"Timestamp",
"documentation":"<p>The end time of the last segment that the service generated.</p>"
},
"Edges":{
"shape":"EdgeList",
"documentation":"<p>Connections to downstream services.</p>"
},
"SummaryStatistics":{
"shape":"ServiceStatistics",
"documentation":"<p>Aggregated statistics for the service.</p>"
"documentation":"<p>Information about an application that processed requests, users that made requests, or downstream services, resources and applications that an application used.</p>"
"documentation":"<p>The unique identifier for the request that generated the trace's segments and subsegments.</p>"
},
"Duration":{
"shape":"NullableDouble",
"documentation":"<p>The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.</p>"
},
"ResponseTime":{
"shape":"NullableDouble",
"documentation":"<p>The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes.</p>"
},
"HasFault":{
"shape":"NullableBoolean",
"documentation":"<p>One or more of the segment documents has a 500 series error.</p>"
},
"HasError":{
"shape":"NullableBoolean",
"documentation":"<p>One or more of the segment documents has a 400 series error.</p>"
},
"HasThrottle":{
"shape":"NullableBoolean",
"documentation":"<p>One or more of the segment documents has a 429 throttling error.</p>"
},
"IsPartial":{
"shape":"NullableBoolean",
"documentation":"<p>One or more of the segment documents is in progress.</p>"
},
"Http":{
"shape":"Http",
"documentation":"<p>Information about the HTTP request served by the trace.</p>"
},
"Annotations":{
"shape":"Annotations",
"documentation":"<p>Annotations from the trace's segment documents.</p>"
},
"Users":{
"shape":"TraceUsers",
"documentation":"<p>Users from the trace's segment documents.</p>"
},
"ServiceIds":{
"shape":"ServiceIds",
"documentation":"<p>Service IDs from the trace's segment documents.</p>"
}
},
"documentation":"<p>Metadata generated from the segment documents in a trace.</p>"
},
"TraceSummaryList":{
"type":"list",
"member":{"shape":"TraceSummary"}
},
"TraceUser":{
"type":"structure",
"members":{
"UserName":{
"shape":"String",
"documentation":"<p>The user's name.</p>"
},
"ServiceIds":{
"shape":"ServiceIds",
"documentation":"<p>Services that the user's request hit.</p>"
}
},
"documentation":"<p>Information about a user recorded in segment documents.</p>"
},
"TraceUsers":{
"type":"list",
"member":{"shape":"TraceUser"}
},
"UnprocessedTraceIdList":{
"type":"list",
"member":{"shape":"TraceId"}
},
"UnprocessedTraceSegment":{
"type":"structure",
"members":{
"Id":{
"shape":"String",
"documentation":"<p>The segment's ID.</p>"
},
"ErrorCode":{
"shape":"String",
"documentation":"<p>The error that caused processing to fail.</p>"
},
"Message":{
"shape":"String",
"documentation":"<p>The error message.</p>"
}
},
"documentation":"<p>Information about a segment that failed processing.</p>"
},
"UnprocessedTraceSegmentList":{
"type":"list",
"member":{"shape":"UnprocessedTraceSegment"}
},
"ValueWithServiceIds":{
"type":"structure",
"members":{
"AnnotationValue":{
"shape":"AnnotationValue",
"documentation":"<p>Values of the annotation.</p>"
},
"ServiceIds":{
"shape":"ServiceIds",
"documentation":"<p>Services to which the annotation applies.</p>"
}
},
"documentation":"<p>Information about a segment annotation.</p>"
},
"ValuesWithServiceIds":{
"type":"list",
"member":{"shape":"ValueWithServiceIds"}
}
},
"documentation":"<p>AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.</p>"
