"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 href=\"https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html\">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 href=\"https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html\">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 the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.</p>"
},
"GetInsightEvents":{
"name":"GetInsightEvents",
"http":{
"method":"POST",
"requestUri":"/InsightEvents"
},
"input":{"shape":"GetInsightEventsRequest"},
"output":{"shape":"GetInsightEventsResult"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottledException"}
],
"documentation":"<p>X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.</p>"
},
"GetInsightImpactGraph":{
"name":"GetInsightImpactGraph",
"http":{
"method":"POST",
"requestUri":"/InsightImpactGraph"
},
"input":{"shape":"GetInsightImpactGraphRequest"},
"output":{"shape":"GetInsightImpactGraphResult"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottledException"}
],
"documentation":"<p>Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.</p>"
},
"GetInsightSummaries":{
"name":"GetInsightSummaries",
"http":{
"method":"POST",
"requestUri":"/InsightSummaries"
},
"input":{"shape":"GetInsightSummariesRequest"},
"output":{"shape":"GetInsightSummariesResult"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottledException"}
],
"documentation":"<p>Retrieves the summaries of all insights in the specified group matching the provided filter values.</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 <a href=\"https://docs.aws.amazon.com/xray/index.html\">Amazon Web Services X-Ray SDK</a>. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.</p>"
"documentation":"<p>Retrieves IDs and annotations 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>Amazon Web Services X-Ray Developer Guide</i>.</p>"
"documentation":"<p>Uploads segment documents to Amazon Web Services X-Ray. The <a href=\"https://docs.aws.amazon.com/xray/index.html\">X-Ray SDK</a> 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\">Amazon Web Services X-Ray Segment Documents</a> in the <i>Amazon Web Services 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 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, for instance, <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>Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an <code>aws:</code> prefix).</p>"
"documentation":"<p>The structure containing configurations related to insights.</p> <ul> <li> <p>The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.</p> </li> <li> <p>The NotifcationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.</p> </li> </ul>"
"documentation":"<p>A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>The following restrictions apply to tags:</p> <ul> <li> <p>Maximum number of user-applied tags per resource: 50</p> </li> <li> <p>Maximum tag key length: 128 Unicode characters</p> </li> <li> <p>Maximum tag value length: 256 Unicode characters</p> </li> <li> <p>Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Don't use <code>aws:</code> as a prefix for keys; it's reserved for Amazon Web Services use.</p> </li> </ul>"
"documentation":"<p>The group that was created. Contains the name of the group that was created, the Amazon Resource Name (ARN) of the group that was generated based on the group name, the filter expression, and the insight configuration that was assigned to the group.</p>"
"documentation":"<p>A map that contains one or more tag keys and tag values to attach to an X-Ray sampling rule. For more information about ways to use tags, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>The following restrictions apply to tags:</p> <ul> <li> <p>Maximum number of user-applied tags per resource: 50</p> </li> <li> <p>Maximum tag key length: 128 Unicode characters</p> </li> <li> <p>Maximum tag value length: 256 Unicode characters</p> </li> <li> <p>Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Don't use <code>aws:</code> as a prefix for keys; it's reserved for Amazon Web Services use.</p> </li> </ul>"
"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>The type of encryption. Set to <code>KMS</code> for encryption with KMS keys. Set to <code>NONE</code> for default encryption.</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 upper limit of fault counts for a service.</p>"
},
"FaultCountLow":{
"shape":"NullableLong",
"documentation":"<p>The lower limit of fault counts for a service.</p>"
}
},
"documentation":"<p>The predicted high and low fault count. This is used to determine if a service has become anomalous and if an insight should be created.</p>"
"documentation":"<p>The group that was requested. Contains the name of the group, the ARN of the group, the filter expression, and the insight configuration assigned to the group.</p>"
"documentation":"<p>The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.</p>"
},
"MaxResults":{
"shape":"GetInsightEventsMaxResults",
"documentation":"<p>Used to retrieve at most the specified value of events.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>Specify the pagination token returned by a previous request to retrieve the next page of events. </p>"
}
}
},
"GetInsightEventsResult":{
"type":"structure",
"members":{
"InsightEvents":{
"shape":"InsightEventList",
"documentation":"<p>A detailed description of the event. This includes the time of the event, client and root cause impact statistics, and the top anomalous service at the time of the event.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>Use this token to retrieve the next page of insight events.</p>"
}
}
},
"GetInsightImpactGraphRequest":{
"type":"structure",
"required":[
"InsightId",
"StartTime",
"EndTime"
],
"members":{
"InsightId":{
"shape":"InsightId",
"documentation":"<p>The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.</p>"
},
"StartTime":{
"shape":"Timestamp",
"documentation":"<p>The estimated start time of the insight, in Unix time seconds. The StartTime is inclusive of the value provided and can't be more than 30 days old.</p>"
},
"EndTime":{
"shape":"Timestamp",
"documentation":"<p>The estimated end time of the insight, in Unix time seconds. The EndTime is exclusive of the value provided. The time range between the start time and end time can't be more than six hours. </p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>Specify the pagination token returned by a previous request to retrieve the next page of results. </p>"
"documentation":"<p>The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.</p>"
}
}
},
"GetInsightResult":{
"type":"structure",
"members":{
"Insight":{
"shape":"Insight",
"documentation":"<p>The summary information of an insight.</p>"
}
}
},
"GetInsightSummariesMaxResults":{
"type":"integer",
"max":100,
"min":1
},
"GetInsightSummariesRequest":{
"type":"structure",
"required":[
"StartTime",
"EndTime"
],
"members":{
"States":{
"shape":"InsightStateList",
"documentation":"<p>The list of insight states. </p>"
},
"GroupARN":{
"shape":"GroupARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.</p>"
},
"GroupName":{
"shape":"GroupName",
"documentation":"<p>The name of the group. Required if the GroupARN isn't provided.</p>"
},
"StartTime":{
"shape":"Timestamp",
"documentation":"<p>The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.</p>"
},
"EndTime":{
"shape":"Timestamp",
"documentation":"<p>The end of the time frame in which the insights ended. The end time can't be more than 30 days old.</p>"
},
"MaxResults":{
"shape":"GetInsightSummariesMaxResults",
"documentation":"<p>The maximum number of results to display.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>Pagination token.</p>"
}
}
},
"GetInsightSummariesResult":{
"type":"structure",
"members":{
"InsightSummaries":{
"shape":"InsightSummaryList",
"documentation":"<p>The summary of each insight within the group matching the provided filters. The summary contains the InsightID, start and end time, the root cause service, the root cause and client impact statistics, the top anomalous services, and the status of the insight.</p>"
"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 href=\"https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html\">GetSamplingRules</a> to get the latest version.</p>"
"documentation":"<p>Information about <a href=\"https://docs.aws.amazon.com/xray/latest/api/API_SamplingStatisticsDocument.html\">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>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>"
"documentation":"<p>The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.</p>"
"documentation":"<p>A flag indicating whether or not a group's filter expression has been consistent, or if a returned aggregation might show statistics from an older version of the group's filter expression.</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 recent results, closest to the end of the time frame.</p>"
"documentation":"<p>The structure containing configurations related to insights.</p> <ul> <li> <p>The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.</p> </li> <li> <p>The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.</p> </li> </ul>"
"documentation":"<p>The structure containing configurations related to insights.</p> <ul> <li> <p>The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.</p> </li> <li> <p>The NotificationsEnabled boolean can be set to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.</p> </li> </ul>"
"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>The Amazon Resource Name (ARN) of the group that the insight belongs to.</p>"
},
"GroupName":{
"shape":"GroupName",
"documentation":"<p>The name of the group that the insight belongs to.</p>"
},
"RootCauseServiceId":{"shape":"ServiceId"},
"Categories":{
"shape":"InsightCategoryList",
"documentation":"<p>The categories that label and describe the type of insight.</p>"
},
"State":{
"shape":"InsightState",
"documentation":"<p>The current state of the insight.</p>"
},
"StartTime":{
"shape":"Timestamp",
"documentation":"<p>The time, in Unix seconds, at which the insight began.</p>"
},
"EndTime":{
"shape":"Timestamp",
"documentation":"<p>The time, in Unix seconds, at which the insight ended.</p>"
},
"Summary":{
"shape":"InsightSummaryText",
"documentation":"<p>A brief description of the insight.</p>"
},
"ClientRequestImpactStatistics":{
"shape":"RequestImpactStatistics",
"documentation":"<p>The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.</p>"
},
"RootCauseServiceRequestImpactStatistics":{
"shape":"RequestImpactStatistics",
"documentation":"<p>The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.</p>"
},
"TopAnomalousServices":{
"shape":"AnomalousServiceList",
"documentation":"<p>The service within the insight that is most impacted by the incident.</p>"
}
},
"documentation":"<p>When fault rates go outside of the expected range, X-Ray creates an insight. Insights tracks emergent issues within your applications.</p>"
},
"InsightCategory":{
"type":"string",
"enum":["FAULT"]
},
"InsightCategoryList":{
"type":"list",
"member":{"shape":"InsightCategory"}
},
"InsightEvent":{
"type":"structure",
"members":{
"Summary":{
"shape":"EventSummaryText",
"documentation":"<p>A brief description of the event.</p>"
},
"EventTime":{
"shape":"Timestamp",
"documentation":"<p>The time, in Unix seconds, at which the event was recorded.</p>"
},
"ClientRequestImpactStatistics":{
"shape":"RequestImpactStatistics",
"documentation":"<p>The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.</p>"
},
"RootCauseServiceRequestImpactStatistics":{
"shape":"RequestImpactStatistics",
"documentation":"<p>The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.</p>"
},
"TopAnomalousServices":{
"shape":"AnomalousServiceList",
"documentation":"<p>The service during the event that is most impacted by the incident.</p>"
}
},
"documentation":"<p>X-Ray reevaluates insights periodically until they are resolved, and records each intermediate state in an event. You can review incident events in the Impact Timeline on the Inspect page in the X-Ray console.</p>"
"documentation":"<p>Identifier for the service. Unique within the service map.</p> <ul> <li> <p>Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used. </p> </li> <li> <p>Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table. </p> </li> <li> <p>Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table. </p> </li> <li> <p>remote - A downstream service of indeterminate type.</p> </li> </ul>"
"documentation":"<p>Connections to downstream services.</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 Amazon Resource Name (ARN) of the group that the insight belongs to.</p>"
},
"GroupName":{
"shape":"GroupName",
"documentation":"<p>The name of the group that the insight belongs to.</p>"
},
"RootCauseServiceId":{"shape":"ServiceId"},
"Categories":{
"shape":"InsightCategoryList",
"documentation":"<p> Categories The categories that label and describe the type of insight.</p>"
},
"State":{
"shape":"InsightState",
"documentation":"<p>The current state of the insight.</p>"
},
"StartTime":{
"shape":"Timestamp",
"documentation":"<p>The time, in Unix seconds, at which the insight began.</p>"
},
"EndTime":{
"shape":"Timestamp",
"documentation":"<p>The time, in Unix seconds, at which the insight ended.</p>"
},
"Summary":{
"shape":"InsightSummaryText",
"documentation":"<p>A brief description of the insight.</p>"
},
"ClientRequestImpactStatistics":{
"shape":"RequestImpactStatistics",
"documentation":"<p>The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay. </p>"
},
"RootCauseServiceRequestImpactStatistics":{
"shape":"RequestImpactStatistics",
"documentation":"<p>The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay. </p>"
},
"TopAnomalousServices":{
"shape":"AnomalousServiceList",
"documentation":"<p>The service within the insight that is most impacted by the incident.</p>"
},
"LastUpdateTime":{
"shape":"Timestamp",
"documentation":"<p>The time, in Unix seconds, that the insight was last updated.</p>"
}
},
"documentation":"<p>Information that describes an insight.</p>"
},
"InsightSummaryList":{
"type":"list",
"member":{"shape":"InsightSummary"}
},
"InsightSummaryText":{"type":"string"},
"InsightsConfiguration":{
"type":"structure",
"members":{
"InsightsEnabled":{
"shape":"NullableBoolean",
"documentation":"<p>Set the InsightsEnabled value to true to enable insights or false to disable insights.</p>"
},
"NotificationsEnabled":{
"shape":"NullableBoolean",
"documentation":"<p>Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.</p>"
}
},
"documentation":"<p>The structure containing configurations related to insights.</p>"
"documentation":"<p>The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token. If multiple pages of results are returned, use the <code>NextToken</code> value returned with the current page of results as the value of this parameter to get the next page of results.</p>"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of tags, as key and value pairs, that is associated with the specified X-Ray group or sampling rule.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token. If multiple pages of results are returned, use the <code>NextToken</code> value returned with the current page of results to get the next page of results.</p>"
"documentation":"<p>An Amazon Web Services KMS key 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>. Amazon Web Services X-Ray does not support asymmetric KMS keys.</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>"
"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>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>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>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 href=\"https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html\">GetSamplingTargets</a>.</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 href=\"https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html\">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 href=\"https://docs.aws.amazon.com/xray/latest/api/API_PutTraceSegments.html\">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\">Amazon Web Services X-Ray Segment Documents</a> in the <i>Amazon Web Services X-Ray Developer Guide</i>.</p>"
"documentation":"<p>The type of service.</p> <ul> <li> <p>Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, <code>AWS::EC2::Instance</code> for an application running on Amazon EC2 or <code>AWS::DynamoDB::Table</code> for an Amazon DynamoDB table that the application used.</p> </li> <li> <p>Amazon Web Services Service - The type of an Amazon Web Services 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>"
"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>A tag key, such as <code>Stage</code> or <code>Name</code>. A tag key cannot be empty. The key can be a maximum of 128 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: <code>+ - = . _ : /</code> </p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>An optional tag value, such as <code>Production</code> or <code>test-only</code>. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: <code>+ - = . _ : /</code> </p>"
"documentation":"<p>A map that contains tag keys and tag values to attach to an Amazon Web Services X-Ray group or sampling rule. For more information about ways to use tags, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>The following restrictions apply to tags:</p> <ul> <li> <p>Maximum number of user-applied tags per resource: 50</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Don't use <code>aws:</code> as a prefix for keys; it's reserved for Amazon Web Services use. You cannot edit or delete system tags.</p> </li> </ul>"
"documentation":"<p>A map that contains one or more tag keys and tag values to attach to an X-Ray group or sampling rule. For more information about ways to use tags, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>The following restrictions apply to tags:</p> <ul> <li> <p>Maximum number of user-applied tags per resource: 50</p> </li> <li> <p>Maximum tag key length: 128 Unicode characters</p> </li> <li> <p>Maximum tag value length: 256 Unicode characters</p> </li> <li> <p>Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Don't use <code>aws:</code> as a prefix for keys; it's reserved for Amazon Web Services use. You cannot edit or delete system tags.</p> </li> </ul>"
"documentation":"<p>LimitExceeded is set to true when the trace has exceeded one of the defined quotas. For more information about quotas, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/xray.html\">Amazon Web Services X-Ray endpoints and quotas</a>.</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>"
"documentation":"<p>Sampling statistics from a call to <a href=\"https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html\">GetSamplingTargets</a> that X-Ray could not process.</p>"
"documentation":"<p>The structure containing configurations related to insights.</p> <ul> <li> <p>The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.</p> </li> <li> <p>The NotifcationsEnabled boolean can be set to true to enable insights notifications for the group. Notifications can only be enabled on a group with InsightsEnabled set to true.</p> </li> </ul>"
"documentation":"<p>The group that was updated. Contains the name of the group that was updated, the ARN of the group that was updated, the updated filter expression, and the updated insight configuration assigned to the group.</p>"
"documentation":"<p>Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.</p>"