"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>Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with <a>GetSamplingRules</a>, and evaluate each rule in ascending order of <i>priority</i> for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with <a>GetSamplingTargets</a> to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.</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>"
"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=\"https://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 case-sensitive name of the new group. Default is a reserved name and names must be unique.</p>"
},
"FilterExpression":{
"shape":"FilterExpression",
"documentation":"<p>The filter expression defining criteria by which to group traces.</p>"
}
}
},
"CreateGroupResult":{
"type":"structure",
"members":{
"Group":{
"shape":"Group",
"documentation":"<p>The group that was created. Contains the name of the group that was created, the ARN of the group that was generated based on the group name, and the filter expression that was assigned to the group.</p>"
"documentation":"<p>The encryption status. While the status is <code>UPDATING</code>, X-Ray may encrypt data with a combination of the new and old settings.</p>"
"documentation":"<p>A list of services corresponding to an error. A service identifies a segment and it contains a name, account ID, type, and inferred flag.</p>"
}
},
"documentation":"<p>The root cause of a trace summary error.</p>"
},
"ErrorRootCauseEntity":{
"type":"structure",
"members":{
"Name":{
"shape":"String",
"documentation":"<p>The name of the entity.</p>"
},
"Exceptions":{
"shape":"RootCauseExceptions",
"documentation":"<p>The types and messages of the exceptions.</p>"
},
"Remote":{
"shape":"NullableBoolean",
"documentation":"<p>A flag that denotes a remote subsegment.</p>"
}
},
"documentation":"<p>A collection of segments and corresponding subsegments associated to a trace summary error.</p>"
},
"ErrorRootCauseEntityPath":{
"type":"list",
"member":{"shape":"ErrorRootCauseEntity"}
},
"ErrorRootCauseService":{
"type":"structure",
"members":{
"Name":{
"shape":"String",
"documentation":"<p>The service name.</p>"
},
"Names":{
"shape":"ServiceNames",
"documentation":"<p>A collection of associated service names.</p>"
},
"Type":{
"shape":"String",
"documentation":"<p>The type associated to the service.</p>"
},
"AccountId":{
"shape":"String",
"documentation":"<p>The account ID associated to the service.</p>"
},
"EntityPath":{
"shape":"ErrorRootCauseEntityPath",
"documentation":"<p>The path of root cause entities found on the service. </p>"
},
"Inferred":{
"shape":"NullableBoolean",
"documentation":"<p>A Boolean value indicating if the service is inferred from the trace.</p>"
}
},
"documentation":"<p>A collection of fields identifying the services in a trace summary error.</p>"
"documentation":"<p>The case-sensitive name of the group.</p>"
},
"GroupARN":{
"shape":"GroupARN",
"documentation":"<p>The ARN of the group that was generated on creation.</p>"
}
}
},
"GetGroupResult":{
"type":"structure",
"members":{
"Group":{
"shape":"Group",
"documentation":"<p>The group that was requested. Contains the name of the group, the ARN of the group, and the filter expression that assigned to the group.</p>"
}
}
},
"GetGroupsNextToken":{
"type":"string",
"max":100,
"min":1
},
"GetGroupsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"GetGroupsNextToken",
"documentation":"<p>Pagination token. Not used.</p>"
}
}
},
"GetGroupsResult":{
"type":"structure",
"members":{
"Groups":{
"shape":"GroupSummaryList",
"documentation":"<p>The collection of all active groups.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
"documentation":"<p>Pagination token. Not used.</p>"
}
}
},
"GetSamplingRulesResult":{
"type":"structure",
"members":{
"SamplingRuleRecords":{
"shape":"SamplingRuleRecordList",
"documentation":"<p>Rule definitions and metadata.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
}
}
},
"GetSamplingStatisticSummariesRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
}
}
},
"GetSamplingStatisticSummariesResult":{
"type":"structure",
"members":{
"SamplingStatisticSummaries":{
"shape":"SamplingStatisticSummaryList",
"documentation":"<p>Information about the number of requests instrumented for each sampling rule.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
}
}
},
"GetSamplingTargetsRequest":{
"type":"structure",
"required":["SamplingStatisticsDocuments"],
"members":{
"SamplingStatisticsDocuments":{
"shape":"SamplingStatisticsDocumentList",
"documentation":"<p>Information about rules that the service is using to sample requests.</p>"
}
}
},
"GetSamplingTargetsResult":{
"type":"structure",
"members":{
"SamplingTargetDocuments":{
"shape":"SamplingTargetDocumentList",
"documentation":"<p>Updated rules that the service should use to sample requests.</p>"
},
"LastRuleModification":{
"shape":"Timestamp",
"documentation":"<p>The last time a user changed the sampling rule configuration. If the sampling rule configuration changed since the service last retrieved it, the service should call <a>GetSamplingRules</a> to get the latest version.</p>"
},
"UnprocessedStatistics":{
"shape":"UnprocessedStatisticsList",
"documentation":"<p>Information about <a>SamplingStatisticsDocument</a> that X-Ray could not process.</p>"
"documentation":"<p>A flag indicating whether the group's filter expression has been consistent, or if the returned service graph may show traces from an older version of the group's filter expression.</p>"
"documentation":"<p>The start of the time frame for which to aggregate statistics.</p>"
},
"EndTime":{
"shape":"Timestamp",
"documentation":"<p>The end of the time frame for which to aggregate statistics.</p>"
},
"GroupName":{
"shape":"GroupName",
"documentation":"<p>The case-sensitive name of the group for which to pull statistics from.</p>"
},
"GroupARN":{
"shape":"GroupARN",
"documentation":"<p>The ARN of the group for which to pull statistics from.</p>"
},
"EntitySelectorExpression":{
"shape":"EntitySelectorExpression",
"documentation":"<p>A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned. </p>"
},
"Period":{
"shape":"NullableInteger",
"documentation":"<p>Aggregation period in seconds.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
}
}
},
"GetTimeSeriesServiceStatisticsResult":{
"type":"structure",
"members":{
"TimeSeriesServiceStatistics":{
"shape":"TimeSeriesServiceStatisticsList",
"documentation":"<p>The collection of statistics.</p>"
},
"ContainsOldGroupVersions":{
"shape":"Boolean",
"documentation":"<p>A flag indicating whether or not a group's filter expression has been consistent, or if a returned aggregation may show statistics from an older version of the group's filter expression.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</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>"
"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>You have reached the maximum number of sampling rules.</p>",
"exception":true
},
"RuleName":{
"type":"string",
"max":32,
"min":1
},
"SampledCount":{
"type":"integer",
"min":0
},
"SamplingRule":{
"type":"structure",
"required":[
"ResourceARN",
"Priority",
"FixedRate",
"ReservoirSize",
"ServiceName",
"ServiceType",
"Host",
"HTTPMethod",
"URLPath",
"Version"
],
"members":{
"RuleName":{
"shape":"RuleName",
"documentation":"<p>The name of the sampling rule. Specify a rule by either name or ARN, but not both.</p>"
},
"RuleARN":{
"shape":"String",
"documentation":"<p>The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.</p>"
},
"ResourceARN":{
"shape":"ResourceARN",
"documentation":"<p>Matches the ARN of the AWS resource on which the service runs.</p>"
},
"Priority":{
"shape":"Priority",
"documentation":"<p>The priority of the sampling rule.</p>"
},
"FixedRate":{
"shape":"FixedRate",
"documentation":"<p>The percentage of matching requests to instrument, after the reservoir is exhausted.</p>"
},
"ReservoirSize":{
"shape":"ReservoirSize",
"documentation":"<p>A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.</p>"
},
"ServiceName":{
"shape":"ServiceName",
"documentation":"<p>Matches the <code>name</code> that the service uses to identify itself in segments.</p>"
},
"ServiceType":{
"shape":"ServiceType",
"documentation":"<p>Matches the <code>origin</code> that the service uses to identify its type in segments.</p>"
},
"Host":{
"shape":"Host",
"documentation":"<p>Matches the hostname from a request URL.</p>"
},
"HTTPMethod":{
"shape":"HTTPMethod",
"documentation":"<p>Matches the HTTP method of a request.</p>"
},
"URLPath":{
"shape":"URLPath",
"documentation":"<p>Matches the path from a request URL.</p>"
},
"Version":{
"shape":"Version",
"documentation":"<p>The version of the sampling rule format (<code>1</code>).</p>"
},
"Attributes":{
"shape":"AttributeMap",
"documentation":"<p>Matches attributes derived from the request.</p>"
}
},
"documentation":"<p>A sampling rule that services use to decide whether to instrument a request. Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don't match its properties.</p>"
},
"SamplingRuleRecord":{
"type":"structure",
"members":{
"SamplingRule":{
"shape":"SamplingRule",
"documentation":"<p>The sampling rule.</p>"
},
"CreatedAt":{
"shape":"Timestamp",
"documentation":"<p>When the rule was created.</p>"
},
"ModifiedAt":{
"shape":"Timestamp",
"documentation":"<p>When the rule was last modified.</p>"
}
},
"documentation":"<p>A <a>SamplingRule</a> and its metadata.</p>"
},
"SamplingRuleRecordList":{
"type":"list",
"member":{"shape":"SamplingRuleRecord"}
},
"SamplingRuleUpdate":{
"type":"structure",
"members":{
"RuleName":{
"shape":"RuleName",
"documentation":"<p>The name of the sampling rule. Specify a rule by either name or ARN, but not both.</p>"
},
"RuleARN":{
"shape":"String",
"documentation":"<p>The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.</p>"
},
"ResourceARN":{
"shape":"ResourceARN",
"documentation":"<p>Matches the ARN of the AWS resource on which the service runs.</p>"
},
"Priority":{
"shape":"NullableInteger",
"documentation":"<p>The priority of the sampling rule.</p>"
},
"FixedRate":{
"shape":"NullableDouble",
"documentation":"<p>The percentage of matching requests to instrument, after the reservoir is exhausted.</p>"
},
"ReservoirSize":{
"shape":"NullableInteger",
"documentation":"<p>A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.</p>"
},
"Host":{
"shape":"Host",
"documentation":"<p>Matches the hostname from a request URL.</p>"
},
"ServiceName":{
"shape":"ServiceName",
"documentation":"<p>Matches the <code>name</code> that the service uses to identify itself in segments.</p>"
},
"ServiceType":{
"shape":"ServiceType",
"documentation":"<p>Matches the <code>origin</code> that the service uses to identify its type in segments.</p>"
},
"HTTPMethod":{
"shape":"HTTPMethod",
"documentation":"<p>Matches the HTTP method of a request.</p>"
},
"URLPath":{
"shape":"URLPath",
"documentation":"<p>Matches the path from a request URL.</p>"
},
"Attributes":{
"shape":"AttributeMap",
"documentation":"<p>Matches attributes derived from the request.</p>"
}
},
"documentation":"<p>A document specifying changes to a sampling rule's configuration.</p>"
},
"SamplingStatisticSummary":{
"type":"structure",
"members":{
"RuleName":{
"shape":"String",
"documentation":"<p>The name of the sampling rule.</p>"
},
"Timestamp":{
"shape":"Timestamp",
"documentation":"<p>The start time of the reporting window.</p>"
},
"RequestCount":{
"shape":"Integer",
"documentation":"<p>The number of requests that matched the rule.</p>"
},
"BorrowCount":{
"shape":"Integer",
"documentation":"<p>The number of requests recorded with borrowed reservoir quota.</p>"
},
"SampledCount":{
"shape":"Integer",
"documentation":"<p>The number of requests recorded.</p>"
}
},
"documentation":"<p>Aggregated request sampling data for a sampling rule across all services for a 10 second window.</p>"
},
"SamplingStatisticSummaryList":{
"type":"list",
"member":{"shape":"SamplingStatisticSummary"}
},
"SamplingStatisticsDocument":{
"type":"structure",
"required":[
"RuleName",
"ClientID",
"Timestamp",
"RequestCount",
"SampledCount"
],
"members":{
"RuleName":{
"shape":"RuleName",
"documentation":"<p>The name of the sampling rule.</p>"
},
"ClientID":{
"shape":"ClientID",
"documentation":"<p>A unique identifier for the service in hexadecimal.</p>"
},
"Timestamp":{
"shape":"Timestamp",
"documentation":"<p>The current time.</p>"
},
"RequestCount":{
"shape":"RequestCount",
"documentation":"<p>The number of requests that matched the rule.</p>"
},
"SampledCount":{
"shape":"SampledCount",
"documentation":"<p>The number of requests recorded.</p>"
},
"BorrowCount":{
"shape":"BorrowCount",
"documentation":"<p>The number of requests recorded with borrowed reservoir quota.</p>"
}
},
"documentation":"<p>Request sampling results for a single rule from a service. Results are for the last 10 seconds unless the service has been assigned a longer reporting interval after a previous call to <a>GetSamplingTargets</a>.</p>"
"documentation":"<p>The name of the sampling rule.</p>"
},
"FixedRate":{
"shape":"Double",
"documentation":"<p>The percentage of matching requests to instrument, after the reservoir is exhausted.</p>"
},
"ReservoirQuota":{
"shape":"NullableInteger",
"documentation":"<p>The number of requests per second that X-Ray allocated this service.</p>"
},
"ReservoirQuotaTTL":{
"shape":"Timestamp",
"documentation":"<p>When the reservoir quota expires.</p>"
},
"Interval":{
"shape":"NullableInteger",
"documentation":"<p>The number of seconds for the service to wait before getting sampling targets again.</p>"
}
},
"documentation":"<p>Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray calculates a new reservoir for each service based on the recent sampling results of all services that called <a>GetSamplingTargets</a>.</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>The updated filter expression defining criteria by which to group traces.</p>"
}
}
},
"UpdateGroupResult":{
"type":"structure",
"members":{
"Group":{
"shape":"Group",
"documentation":"<p>The group that was updated. Contains the name of the group that was updated, the ARN of the group that was updated, and the updated filter expression assigned to the group.</p>"
"documentation":"<p>AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.</p>"