prowler-sdk-poc
Version:
1,124 lines • 79 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class XRay extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: XRay.Types.ClientConfiguration)
config: Config & XRay.Types.ClientConfiguration;
/**
* Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.
*/
batchGetTraces(params: XRay.Types.BatchGetTracesRequest, callback?: (err: AWSError, data: XRay.Types.BatchGetTracesResult) => void): Request<XRay.Types.BatchGetTracesResult, AWSError>;
/**
* Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.
*/
batchGetTraces(callback?: (err: AWSError, data: XRay.Types.BatchGetTracesResult) => void): Request<XRay.Types.BatchGetTracesResult, AWSError>;
/**
* Creates a group resource with a name and a filter expression.
*/
createGroup(params: XRay.Types.CreateGroupRequest, callback?: (err: AWSError, data: XRay.Types.CreateGroupResult) => void): Request<XRay.Types.CreateGroupResult, AWSError>;
/**
* Creates a group resource with a name and a filter expression.
*/
createGroup(callback?: (err: AWSError, data: XRay.Types.CreateGroupResult) => void): Request<XRay.Types.CreateGroupResult, AWSError>;
/**
* Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority 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 GetSamplingTargets 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.
*/
createSamplingRule(params: XRay.Types.CreateSamplingRuleRequest, callback?: (err: AWSError, data: XRay.Types.CreateSamplingRuleResult) => void): Request<XRay.Types.CreateSamplingRuleResult, AWSError>;
/**
* Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority 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 GetSamplingTargets 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.
*/
createSamplingRule(callback?: (err: AWSError, data: XRay.Types.CreateSamplingRuleResult) => void): Request<XRay.Types.CreateSamplingRuleResult, AWSError>;
/**
* Deletes a group resource.
*/
deleteGroup(params: XRay.Types.DeleteGroupRequest, callback?: (err: AWSError, data: XRay.Types.DeleteGroupResult) => void): Request<XRay.Types.DeleteGroupResult, AWSError>;
/**
* Deletes a group resource.
*/
deleteGroup(callback?: (err: AWSError, data: XRay.Types.DeleteGroupResult) => void): Request<XRay.Types.DeleteGroupResult, AWSError>;
/**
* Deletes a sampling rule.
*/
deleteSamplingRule(params: XRay.Types.DeleteSamplingRuleRequest, callback?: (err: AWSError, data: XRay.Types.DeleteSamplingRuleResult) => void): Request<XRay.Types.DeleteSamplingRuleResult, AWSError>;
/**
* Deletes a sampling rule.
*/
deleteSamplingRule(callback?: (err: AWSError, data: XRay.Types.DeleteSamplingRuleResult) => void): Request<XRay.Types.DeleteSamplingRuleResult, AWSError>;
/**
* Retrieves the current encryption configuration for X-Ray data.
*/
getEncryptionConfig(params: XRay.Types.GetEncryptionConfigRequest, callback?: (err: AWSError, data: XRay.Types.GetEncryptionConfigResult) => void): Request<XRay.Types.GetEncryptionConfigResult, AWSError>;
/**
* Retrieves the current encryption configuration for X-Ray data.
*/
getEncryptionConfig(callback?: (err: AWSError, data: XRay.Types.GetEncryptionConfigResult) => void): Request<XRay.Types.GetEncryptionConfigResult, AWSError>;
/**
* Retrieves group resource details.
*/
getGroup(params: XRay.Types.GetGroupRequest, callback?: (err: AWSError, data: XRay.Types.GetGroupResult) => void): Request<XRay.Types.GetGroupResult, AWSError>;
/**
* Retrieves group resource details.
*/
getGroup(callback?: (err: AWSError, data: XRay.Types.GetGroupResult) => void): Request<XRay.Types.GetGroupResult, AWSError>;
/**
* Retrieves all active group details.
*/
getGroups(params: XRay.Types.GetGroupsRequest, callback?: (err: AWSError, data: XRay.Types.GetGroupsResult) => void): Request<XRay.Types.GetGroupsResult, AWSError>;
/**
* Retrieves all active group details.
*/
getGroups(callback?: (err: AWSError, data: XRay.Types.GetGroupsResult) => void): Request<XRay.Types.GetGroupsResult, AWSError>;
/**
* 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.
*/
getInsight(params: XRay.Types.GetInsightRequest, callback?: (err: AWSError, data: XRay.Types.GetInsightResult) => void): Request<XRay.Types.GetInsightResult, AWSError>;
/**
* 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.
*/
getInsight(callback?: (err: AWSError, data: XRay.Types.GetInsightResult) => void): Request<XRay.Types.GetInsightResult, AWSError>;
/**
* 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.
*/
getInsightEvents(params: XRay.Types.GetInsightEventsRequest, callback?: (err: AWSError, data: XRay.Types.GetInsightEventsResult) => void): Request<XRay.Types.GetInsightEventsResult, AWSError>;
/**
* 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.
*/
getInsightEvents(callback?: (err: AWSError, data: XRay.Types.GetInsightEventsResult) => void): Request<XRay.Types.GetInsightEventsResult, AWSError>;
/**
* 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.
*/
getInsightImpactGraph(params: XRay.Types.GetInsightImpactGraphRequest, callback?: (err: AWSError, data: XRay.Types.GetInsightImpactGraphResult) => void): Request<XRay.Types.GetInsightImpactGraphResult, AWSError>;
/**
* 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.
*/
getInsightImpactGraph(callback?: (err: AWSError, data: XRay.Types.GetInsightImpactGraphResult) => void): Request<XRay.Types.GetInsightImpactGraphResult, AWSError>;
/**
* Retrieves the summaries of all insights in the specified group matching the provided filter values.
*/
getInsightSummaries(params: XRay.Types.GetInsightSummariesRequest, callback?: (err: AWSError, data: XRay.Types.GetInsightSummariesResult) => void): Request<XRay.Types.GetInsightSummariesResult, AWSError>;
/**
* Retrieves the summaries of all insights in the specified group matching the provided filter values.
*/
getInsightSummaries(callback?: (err: AWSError, data: XRay.Types.GetInsightSummariesResult) => void): Request<XRay.Types.GetInsightSummariesResult, AWSError>;
/**
* Retrieves all sampling rules.
*/
getSamplingRules(params: XRay.Types.GetSamplingRulesRequest, callback?: (err: AWSError, data: XRay.Types.GetSamplingRulesResult) => void): Request<XRay.Types.GetSamplingRulesResult, AWSError>;
/**
* Retrieves all sampling rules.
*/
getSamplingRules(callback?: (err: AWSError, data: XRay.Types.GetSamplingRulesResult) => void): Request<XRay.Types.GetSamplingRulesResult, AWSError>;
/**
* Retrieves information about recent sampling results for all sampling rules.
*/
getSamplingStatisticSummaries(params: XRay.Types.GetSamplingStatisticSummariesRequest, callback?: (err: AWSError, data: XRay.Types.GetSamplingStatisticSummariesResult) => void): Request<XRay.Types.GetSamplingStatisticSummariesResult, AWSError>;
/**
* Retrieves information about recent sampling results for all sampling rules.
*/
getSamplingStatisticSummaries(callback?: (err: AWSError, data: XRay.Types.GetSamplingStatisticSummariesResult) => void): Request<XRay.Types.GetSamplingStatisticSummariesResult, AWSError>;
/**
* Requests a sampling quota for rules that the service is using to sample requests.
*/
getSamplingTargets(params: XRay.Types.GetSamplingTargetsRequest, callback?: (err: AWSError, data: XRay.Types.GetSamplingTargetsResult) => void): Request<XRay.Types.GetSamplingTargetsResult, AWSError>;
/**
* Requests a sampling quota for rules that the service is using to sample requests.
*/
getSamplingTargets(callback?: (err: AWSError, data: XRay.Types.GetSamplingTargetsResult) => void): Request<XRay.Types.GetSamplingTargetsResult, AWSError>;
/**
* 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 Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.
*/
getServiceGraph(params: XRay.Types.GetServiceGraphRequest, callback?: (err: AWSError, data: XRay.Types.GetServiceGraphResult) => void): Request<XRay.Types.GetServiceGraphResult, AWSError>;
/**
* 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 Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.
*/
getServiceGraph(callback?: (err: AWSError, data: XRay.Types.GetServiceGraphResult) => void): Request<XRay.Types.GetServiceGraphResult, AWSError>;
/**
* Get an aggregation of service statistics defined by a specific time range.
*/
getTimeSeriesServiceStatistics(params: XRay.Types.GetTimeSeriesServiceStatisticsRequest, callback?: (err: AWSError, data: XRay.Types.GetTimeSeriesServiceStatisticsResult) => void): Request<XRay.Types.GetTimeSeriesServiceStatisticsResult, AWSError>;
/**
* Get an aggregation of service statistics defined by a specific time range.
*/
getTimeSeriesServiceStatistics(callback?: (err: AWSError, data: XRay.Types.GetTimeSeriesServiceStatisticsResult) => void): Request<XRay.Types.GetTimeSeriesServiceStatisticsResult, AWSError>;
/**
* Retrieves a service graph for one or more specific trace IDs.
*/
getTraceGraph(params: XRay.Types.GetTraceGraphRequest, callback?: (err: AWSError, data: XRay.Types.GetTraceGraphResult) => void): Request<XRay.Types.GetTraceGraphResult, AWSError>;
/**
* Retrieves a service graph for one or more specific trace IDs.
*/
getTraceGraph(callback?: (err: AWSError, data: XRay.Types.GetTraceGraphResult) => void): Request<XRay.Types.GetTraceGraphResult, AWSError>;
/**
* 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 BatchGetTraces. 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 api.example.com: service("api.example.com") This filter expression finds traces that have an annotation named account with the value 12345: annotation.account = "12345" For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the Amazon Web Services X-Ray Developer Guide.
*/
getTraceSummaries(params: XRay.Types.GetTraceSummariesRequest, callback?: (err: AWSError, data: XRay.Types.GetTraceSummariesResult) => void): Request<XRay.Types.GetTraceSummariesResult, AWSError>;
/**
* 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 BatchGetTraces. 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 api.example.com: service("api.example.com") This filter expression finds traces that have an annotation named account with the value 12345: annotation.account = "12345" For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the Amazon Web Services X-Ray Developer Guide.
*/
getTraceSummaries(callback?: (err: AWSError, data: XRay.Types.GetTraceSummariesResult) => void): Request<XRay.Types.GetTraceSummariesResult, AWSError>;
/**
* Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
*/
listTagsForResource(params: XRay.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: XRay.Types.ListTagsForResourceResponse) => void): Request<XRay.Types.ListTagsForResourceResponse, AWSError>;
/**
* Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
*/
listTagsForResource(callback?: (err: AWSError, data: XRay.Types.ListTagsForResourceResponse) => void): Request<XRay.Types.ListTagsForResourceResponse, AWSError>;
/**
* Updates the encryption configuration for X-Ray data.
*/
putEncryptionConfig(params: XRay.Types.PutEncryptionConfigRequest, callback?: (err: AWSError, data: XRay.Types.PutEncryptionConfigResult) => void): Request<XRay.Types.PutEncryptionConfigResult, AWSError>;
/**
* Updates the encryption configuration for X-Ray data.
*/
putEncryptionConfig(callback?: (err: AWSError, data: XRay.Types.PutEncryptionConfigResult) => void): Request<XRay.Types.PutEncryptionConfigResult, AWSError>;
/**
* Used by the Amazon Web Services X-Ray daemon to upload telemetry.
*/
putTelemetryRecords(params: XRay.Types.PutTelemetryRecordsRequest, callback?: (err: AWSError, data: XRay.Types.PutTelemetryRecordsResult) => void): Request<XRay.Types.PutTelemetryRecordsResult, AWSError>;
/**
* Used by the Amazon Web Services X-Ray daemon to upload telemetry.
*/
putTelemetryRecords(callback?: (err: AWSError, data: XRay.Types.PutTelemetryRecordsResult) => void): Request<XRay.Types.PutTelemetryRecordsResult, AWSError>;
/**
* Uploads segment documents to Amazon Web Services 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. Segments must include the following fields. For the full segment document schema, see Amazon Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer Guide. Required segment document fields name - The name of the service that handled the request. id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits. trace_id - A unique identifier that connects all segments and subsegments originating from a single client request. start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9. end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress. in_progress - Set to true instead of specifying an end_time 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. A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes: Trace ID Format The version number, for instance, 1. 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 1480615200 seconds, or 58406520 in hexadecimal. A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.
*/
putTraceSegments(params: XRay.Types.PutTraceSegmentsRequest, callback?: (err: AWSError, data: XRay.Types.PutTraceSegmentsResult) => void): Request<XRay.Types.PutTraceSegmentsResult, AWSError>;
/**
* Uploads segment documents to Amazon Web Services 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. Segments must include the following fields. For the full segment document schema, see Amazon Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer Guide. Required segment document fields name - The name of the service that handled the request. id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits. trace_id - A unique identifier that connects all segments and subsegments originating from a single client request. start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9. end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress. in_progress - Set to true instead of specifying an end_time 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. A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes: Trace ID Format The version number, for instance, 1. 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 1480615200 seconds, or 58406520 in hexadecimal. A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.
*/
putTraceSegments(callback?: (err: AWSError, data: XRay.Types.PutTraceSegmentsResult) => void): Request<XRay.Types.PutTraceSegmentsResult, AWSError>;
/**
* Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
*/
tagResource(params: XRay.Types.TagResourceRequest, callback?: (err: AWSError, data: XRay.Types.TagResourceResponse) => void): Request<XRay.Types.TagResourceResponse, AWSError>;
/**
* Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
*/
tagResource(callback?: (err: AWSError, data: XRay.Types.TagResourceResponse) => void): Request<XRay.Types.TagResourceResponse, AWSError>;
/**
* Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix).
*/
untagResource(params: XRay.Types.UntagResourceRequest, callback?: (err: AWSError, data: XRay.Types.UntagResourceResponse) => void): Request<XRay.Types.UntagResourceResponse, AWSError>;
/**
* Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix).
*/
untagResource(callback?: (err: AWSError, data: XRay.Types.UntagResourceResponse) => void): Request<XRay.Types.UntagResourceResponse, AWSError>;
/**
* Updates a group resource.
*/
updateGroup(params: XRay.Types.UpdateGroupRequest, callback?: (err: AWSError, data: XRay.Types.UpdateGroupResult) => void): Request<XRay.Types.UpdateGroupResult, AWSError>;
/**
* Updates a group resource.
*/
updateGroup(callback?: (err: AWSError, data: XRay.Types.UpdateGroupResult) => void): Request<XRay.Types.UpdateGroupResult, AWSError>;
/**
* Modifies a sampling rule's configuration.
*/
updateSamplingRule(params: XRay.Types.UpdateSamplingRuleRequest, callback?: (err: AWSError, data: XRay.Types.UpdateSamplingRuleResult) => void): Request<XRay.Types.UpdateSamplingRuleResult, AWSError>;
/**
* Modifies a sampling rule's configuration.
*/
updateSamplingRule(callback?: (err: AWSError, data: XRay.Types.UpdateSamplingRuleResult) => void): Request<XRay.Types.UpdateSamplingRuleResult, AWSError>;
}
declare namespace XRay {
export interface Alias {
/**
* The canonical name of the alias.
*/
Name?: String;
/**
* A list of names for the alias, including the canonical name.
*/
Names?: AliasNames;
/**
* The type of the alias.
*/
Type?: String;
}
export type AliasList = Alias[];
export type AliasNames = String[];
export type AmazonResourceName = string;
export type AnnotationKey = string;
export interface AnnotationValue {
/**
* Value for a Number annotation.
*/
NumberValue?: NullableDouble;
/**
* Value for a Boolean annotation.
*/
BooleanValue?: NullableBoolean;
/**
* Value for a String annotation.
*/
StringValue?: String;
}
export type Annotations = {[key: string]: ValuesWithServiceIds};
export interface AnomalousService {
ServiceId?: ServiceId;
}
export type AnomalousServiceList = AnomalousService[];
export type AttributeKey = string;
export type AttributeMap = {[key: string]: AttributeValue};
export type AttributeValue = string;
export interface AvailabilityZoneDetail {
/**
* The name of a corresponding Availability Zone.
*/
Name?: String;
}
export interface BackendConnectionErrors {
/**
*
*/
TimeoutCount?: NullableInteger;
/**
*
*/
ConnectionRefusedCount?: NullableInteger;
/**
*
*/
HTTPCode4XXCount?: NullableInteger;
/**
*
*/
HTTPCode5XXCount?: NullableInteger;
/**
*
*/
UnknownHostCount?: NullableInteger;
/**
*
*/
OtherCount?: NullableInteger;
}
export interface BatchGetTracesRequest {
/**
* Specify the trace IDs of requests for which to retrieve segments.
*/
TraceIds: TraceIdList;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface BatchGetTracesResult {
/**
* Full traces for the specified requests.
*/
Traces?: TraceList;
/**
* Trace IDs of requests that haven't been processed.
*/
UnprocessedTraceIds?: UnprocessedTraceIdList;
/**
* Pagination token.
*/
NextToken?: String;
}
export type Boolean = boolean;
export type BorrowCount = number;
export type ClientID = string;
export interface CreateGroupRequest {
/**
* The case-sensitive name of the new group. Default is a reserved name and names must be unique.
*/
GroupName: GroupName;
/**
* The filter expression defining criteria by which to group traces.
*/
FilterExpression?: FilterExpression;
/**
* The structure containing configurations related to insights. The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group. 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.
*/
InsightsConfiguration?: InsightsConfiguration;
/**
* 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 Tagging Amazon Web Services resources in the Amazon Web Services General Reference. The following restrictions apply to tags: Maximum number of user-applied tags per resource: 50 Maximum tag key length: 128 Unicode characters Maximum tag value length: 256 Unicode characters Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @ Tag keys and values are case sensitive. Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.
*/
Tags?: TagList;
}
export interface CreateGroupResult {
/**
* 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.
*/
Group?: Group;
}
export interface CreateSamplingRuleRequest {
/**
* The rule definition.
*/
SamplingRule: SamplingRule;
/**
* 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 Tagging Amazon Web Services resources in the Amazon Web Services General Reference. The following restrictions apply to tags: Maximum number of user-applied tags per resource: 50 Maximum tag key length: 128 Unicode characters Maximum tag value length: 256 Unicode characters Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @ Tag keys and values are case sensitive. Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.
*/
Tags?: TagList;
}
export interface CreateSamplingRuleResult {
/**
* The saved rule definition and metadata.
*/
SamplingRuleRecord?: SamplingRuleRecord;
}
export interface DeleteGroupRequest {
/**
* The case-sensitive name of the group.
*/
GroupName?: GroupName;
/**
* The ARN of the group that was generated on creation.
*/
GroupARN?: GroupARN;
}
export interface DeleteGroupResult {
}
export interface DeleteSamplingRuleRequest {
/**
* The name of the sampling rule. Specify a rule by either name or ARN, but not both.
*/
RuleName?: String;
/**
* The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
*/
RuleARN?: String;
}
export interface DeleteSamplingRuleResult {
/**
* The deleted rule definition and metadata.
*/
SamplingRuleRecord?: SamplingRuleRecord;
}
export type Double = number;
export type EC2InstanceId = string;
export interface Edge {
/**
* Identifier of the edge. Unique within a service map.
*/
ReferenceId?: NullableInteger;
/**
* The start time of the first segment on the edge.
*/
StartTime?: Timestamp;
/**
* The end time of the last segment on the edge.
*/
EndTime?: Timestamp;
/**
* Response statistics for segments on the edge.
*/
SummaryStatistics?: EdgeStatistics;
/**
* A histogram that maps the spread of client response times on an edge.
*/
ResponseTimeHistogram?: Histogram;
/**
* Aliases for the edge.
*/
Aliases?: AliasList;
}
export type EdgeList = Edge[];
export interface EdgeStatistics {
/**
* The number of requests that completed with a 2xx Success status code.
*/
OkCount?: NullableLong;
/**
* Information about requests that failed with a 4xx Client Error status code.
*/
ErrorStatistics?: ErrorStatistics;
/**
* Information about requests that failed with a 5xx Server Error status code.
*/
FaultStatistics?: FaultStatistics;
/**
* The total number of completed requests.
*/
TotalCount?: NullableLong;
/**
* The aggregate response time of completed requests.
*/
TotalResponseTime?: NullableDouble;
}
export interface EncryptionConfig {
/**
* The ID of the KMS key used for encryption, if applicable.
*/
KeyId?: String;
/**
* The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.
*/
Status?: EncryptionStatus;
/**
* The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE for default encryption.
*/
Type?: EncryptionType;
}
export type EncryptionKeyId = string;
export type EncryptionStatus = "UPDATING"|"ACTIVE"|string;
export type EncryptionType = "NONE"|"KMS"|string;
export type EntitySelectorExpression = string;
export interface ErrorRootCause {
/**
* A list of services corresponding to an error. A service identifies a segment and it contains a name, account ID, type, and inferred flag.
*/
Services?: ErrorRootCauseServices;
/**
* A flag that denotes that the root cause impacts the trace client.
*/
ClientImpacting?: NullableBoolean;
}
export interface ErrorRootCauseEntity {
/**
* The name of the entity.
*/
Name?: String;
/**
* The types and messages of the exceptions.
*/
Exceptions?: RootCauseExceptions;
/**
* A flag that denotes a remote subsegment.
*/
Remote?: NullableBoolean;
}
export type ErrorRootCauseEntityPath = ErrorRootCauseEntity[];
export interface ErrorRootCauseService {
/**
* The service name.
*/
Name?: String;
/**
* A collection of associated service names.
*/
Names?: ServiceNames;
/**
* The type associated to the service.
*/
Type?: String;
/**
* The account ID associated to the service.
*/
AccountId?: String;
/**
* The path of root cause entities found on the service.
*/
EntityPath?: ErrorRootCauseEntityPath;
/**
* A Boolean value indicating if the service is inferred from the trace.
*/
Inferred?: NullableBoolean;
}
export type ErrorRootCauseServices = ErrorRootCauseService[];
export type ErrorRootCauses = ErrorRootCause[];
export interface ErrorStatistics {
/**
* The number of requests that failed with a 419 throttling status code.
*/
ThrottleCount?: NullableLong;
/**
* The number of requests that failed with untracked 4xx Client Error status codes.
*/
OtherCount?: NullableLong;
/**
* The total number of requests that failed with a 4xx Client Error status code.
*/
TotalCount?: NullableLong;
}
export type EventSummaryText = string;
export interface FaultRootCause {
/**
* A list of corresponding services. A service identifies a segment and it contains a name, account ID, type, and inferred flag.
*/
Services?: FaultRootCauseServices;
/**
* A flag that denotes that the root cause impacts the trace client.
*/
ClientImpacting?: NullableBoolean;
}
export interface FaultRootCauseEntity {
/**
* The name of the entity.
*/
Name?: String;
/**
* The types and messages of the exceptions.
*/
Exceptions?: RootCauseExceptions;
/**
* A flag that denotes a remote subsegment.
*/
Remote?: NullableBoolean;
}
export type FaultRootCauseEntityPath = FaultRootCauseEntity[];
export interface FaultRootCauseService {
/**
* The service name.
*/
Name?: String;
/**
* A collection of associated service names.
*/
Names?: ServiceNames;
/**
* The type associated to the service.
*/
Type?: String;
/**
* The account ID associated to the service.
*/
AccountId?: String;
/**
* The path of root cause entities found on the service.
*/
EntityPath?: FaultRootCauseEntityPath;
/**
* A Boolean value indicating if the service is inferred from the trace.
*/
Inferred?: NullableBoolean;
}
export type FaultRootCauseServices = FaultRootCauseService[];
export type FaultRootCauses = FaultRootCause[];
export interface FaultStatistics {
/**
* The number of requests that failed with untracked 5xx Server Error status codes.
*/
OtherCount?: NullableLong;
/**
* The total number of requests that failed with a 5xx Server Error status code.
*/
TotalCount?: NullableLong;
}
export type FilterExpression = string;
export type FixedRate = number;
export interface ForecastStatistics {
/**
* The upper limit of fault counts for a service.
*/
FaultCountHigh?: NullableLong;
/**
* The lower limit of fault counts for a service.
*/
FaultCountLow?: NullableLong;
}
export interface GetEncryptionConfigRequest {
}
export interface GetEncryptionConfigResult {
/**
* The encryption configuration document.
*/
EncryptionConfig?: EncryptionConfig;
}
export interface GetGroupRequest {
/**
* The case-sensitive name of the group.
*/
GroupName?: GroupName;
/**
* The ARN of the group that was generated on creation.
*/
GroupARN?: GroupARN;
}
export interface GetGroupResult {
/**
* 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.
*/
Group?: Group;
}
export type GetGroupsNextToken = string;
export interface GetGroupsRequest {
/**
* Pagination token.
*/
NextToken?: GetGroupsNextToken;
}
export interface GetGroupsResult {
/**
* The collection of all active groups.
*/
Groups?: GroupSummaryList;
/**
* Pagination token.
*/
NextToken?: String;
}
export type GetInsightEventsMaxResults = number;
export interface GetInsightEventsRequest {
/**
* The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
*/
InsightId: InsightId;
/**
* Used to retrieve at most the specified value of events.
*/
MaxResults?: GetInsightEventsMaxResults;
/**
* Specify the pagination token returned by a previous request to retrieve the next page of events.
*/
NextToken?: Token;
}
export interface GetInsightEventsResult {
/**
* 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.
*/
InsightEvents?: InsightEventList;
/**
* Use this token to retrieve the next page of insight events.
*/
NextToken?: Token;
}
export interface GetInsightImpactGraphRequest {
/**
* The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
*/
InsightId: InsightId;
/**
* 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.
*/
StartTime: Timestamp;
/**
* 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.
*/
EndTime: Timestamp;
/**
* Specify the pagination token returned by a previous request to retrieve the next page of results.
*/
NextToken?: Token;
}
export interface GetInsightImpactGraphResult {
/**
* The insight's unique identifier.
*/
InsightId?: InsightId;
/**
* The provided start time.
*/
StartTime?: Timestamp;
/**
* The provided end time.
*/
EndTime?: Timestamp;
/**
* The time, in Unix seconds, at which the service graph started.
*/
ServiceGraphStartTime?: Timestamp;
/**
* The time, in Unix seconds, at which the service graph ended.
*/
ServiceGraphEndTime?: Timestamp;
/**
* The Amazon Web Services instrumented services related to the insight.
*/
Services?: InsightImpactGraphServiceList;
/**
* Pagination token.
*/
NextToken?: Token;
}
export interface GetInsightRequest {
/**
* The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
*/
InsightId: InsightId;
}
export interface GetInsightResult {
/**
* The summary information of an insight.
*/
Insight?: Insight;
}
export type GetInsightSummariesMaxResults = number;
export interface GetInsightSummariesRequest {
/**
* The list of insight states.
*/
States?: InsightStateList;
/**
* The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.
*/
GroupARN?: GroupARN;
/**
* The name of the group. Required if the GroupARN isn't provided.
*/
GroupName?: GroupName;
/**
* The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.
*/
StartTime: Timestamp;
/**
* The end of the time frame in which the insights ended. The end time can't be more than 30 days old.
*/
EndTime: Timestamp;
/**
* The maximum number of results to display.
*/
MaxResults?: GetInsightSummariesMaxResults;
/**
* Pagination token.
*/
NextToken?: Token;
}
export interface GetInsightSummariesResult {
/**
* 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.
*/
InsightSummaries?: InsightSummaryList;
/**
* Pagination token.
*/
NextToken?: Token;
}
export interface GetSamplingRulesRequest {
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetSamplingRulesResult {
/**
* Rule definitions and metadata.
*/
SamplingRuleRecords?: SamplingRuleRecordList;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetSamplingStatisticSummariesRequest {
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetSamplingStatisticSummariesResult {
/**
* Information about the number of requests instrumented for each sampling rule.
*/
SamplingStatisticSummaries?: SamplingStatisticSummaryList;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetSamplingTargetsRequest {
/**
* Information about rules that the service is using to sample requests.
*/
SamplingStatisticsDocuments: SamplingStatisticsDocumentList;
}
export interface GetSamplingTargetsResult {
/**
* Updated rules that the service should use to sample requests.
*/
SamplingTargetDocuments?: SamplingTargetDocumentList;
/**
* 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 GetSamplingRules to get the latest version.
*/
LastRuleModification?: Timestamp;
/**
* Information about SamplingStatisticsDocument that X-Ray could not process.
*/
UnprocessedStatistics?: UnprocessedStatisticsList;
}
export interface GetServiceGraphRequest {
/**
* The start of the time frame for which to generate a graph.
*/
StartTime: Timestamp;
/**
* The end of the timeframe for which to generate a graph.
*/
EndTime: Timestamp;
/**
* The name of a group based on which you want to generate a graph.
*/
GroupName?: GroupName;
/**
* The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.
*/
GroupARN?: GroupARN;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetServiceGraphResult {
/**
* The start of the time frame for which the graph was generated.
*/
StartTime?: Timestamp;
/**
* The end of the time frame for which the graph was generated.
*/
EndTime?: Timestamp;
/**
* The services that have processed a traced request during the specified time frame.
*/
Services?: ServiceList;
/**
* 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.
*/
ContainsOldGroupVersions?: Boolean;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetTimeSeriesServiceStatisticsRequest {
/**
* The start of the time frame for which to aggregate statistics.
*/
StartTime: Timestamp;
/**
* The end of the time frame for which to aggregate statistics.
*/
EndTime: Timestamp;
/**
* The case-sensitive name of the group for which to pull statistics from.
*/
GroupName?: GroupName;
/**
* The Amazon Resource Name (ARN) of the group for which to pull statistics from.
*/
GroupARN?: GroupARN;
/**
* 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.
*/
EntitySelectorExpression?: EntitySelectorExpression;
/**
* Aggregation period in seconds.
*/
Period?: NullableInteger;
/**
* The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.
*/
ForecastStatistics?: NullableBoolean;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetTimeSeriesServiceStatisticsResult {
/**
* The collection of statistics.
*/
TimeSeriesServiceStatistics?: TimeSeriesServiceStatisticsList;
/**
* 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.
*/
ContainsOldGroupVersions?: Boolean;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetTraceGraphRequest {
/**
* Trace IDs of requests for which to generate a service graph.
*/
TraceIds: TraceIdList;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetTraceGraphResult {
/**
* The services that have processed one of the specified requests.
*/
Services?: ServiceList;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetTraceSummariesRequest {
/**
* The start of the time frame for which to retrieve traces.
*/
StartTime: Timestamp;
/**
* The end of the time frame for which to retrieve traces.
*/
EndTime: Timestamp;
/**
* A parameter to indicate whether to query trace summaries by TraceId or Event time.
*/
TimeRangeType?: TimeRangeType;
/**
* Set to true to get summaries for only a subset of available traces.
*/
Sampling?: NullableBoolean;
/**
* A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.
*/
SamplingStrategy?: SamplingStrategy;
/**
* Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.
*/
FilterExpression?: FilterExpression;
/**
* Specify the pagination token returned by a previous request to retrieve the next page of results.
*/
NextToken?: String;
}
export interface GetTraceSummariesResult {
/**
* Trace IDs and annotations for traces that were found in the specified time frame.
*/
TraceSummaries?: TraceSummaryList;
/**
* The start time of this page of results.
*/
ApproximateTime?: Timestamp;
/**
* The total number of traces processed, including traces that did not match the specified filter expression.
*/
TracesProcessedCount?: NullableLong;
/**
* 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.
*/
NextToken?: String;
}
export interface Group {
/**
* The unique case-sensitive name of the group.
*/
GroupName?: String;
/**
* The Amazon Resource Name (ARN) of the group generated based on the GroupName.
*/
GroupARN?: String;
/**
* The filter expression defining the parameters to include traces.
*/
FilterExpression?: String;
/**
* The structure containing configurations related to insights. The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group. The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.
*/
InsightsConfiguration?: InsightsConfiguration;
}
export type GroupARN = string;
export type GroupName = string;
export interface GroupSummary {
/**
* The unique case-sensitive name of the group.
*/
GroupName?: String;
/**
* The ARN of the group generated based on the GroupName.
*/
GroupARN?: String;
/**
* The filter expression defining the parameters to include traces.
*/
FilterExpression?: String;
/**
* The structure containing configurations related to insights. The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group. 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.
*/
InsightsConfiguration?: InsightsConfiguration;
}
export type GroupSummaryList = GroupSummary[];
export type HTTPMethod = string;
export type Histogram = HistogramEntry[];
export interface HistogramEntry {
/**
* The value of the entry.
*/
Value?: Double;
/**
* The prevalence of the entry.
*/
Count?: Integer;
}
export type Host = string;
export type Hostname = string;
export interface Http {
/**
* The request URL.
*/
HttpURL?: String;
/**
* The response status.
*/
HttpStatus?: NullableInteger;
/**
* The request method.
*/
HttpMethod?: String;
/**
* The request's user agent string.
*/
UserAgent?: String;
/**
* The IP address of the requestor.
*/
ClientIp?: String;
}
export interface Insight {
/**
* The insights unique identifier.
*/
InsightId?: InsightId;
/**
* The Amazon Resource Name (ARN) of the group that the insight belongs to.
*/
GroupARN?: GroupARN;
/**
* The name of the group that the insight belongs to.
*/
GroupName?: GroupName;
RootCauseServiceId?: ServiceId;
/**
* The categories that label and describe the type of insight.
*/
Categories?: InsightCategoryList;
/**
* The current state of the insight.
*/
State?: InsightState;
/**
* The time, in Unix seconds, at which the insight began.
*/
StartTime?: Timestamp;
/**
* The time, in Unix seconds, at which the insight ended.
*/
EndTime?: Timestamp;
/**
* A brief description of the insight.
*/
Summary?: InsightSummaryText;
/**
* 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.
*/
ClientRequestImpactStatistics?: RequestImpactStatistics;
/**
* 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.
*/
RootCauseServiceRequestImpactStatistics?: RequestImpactStatistics;
/**
* The service within the insight that is most impacted by the incident.
*/
TopAnomalousServices?: AnomalousServiceList;
}
export type InsightCategory = "FAULT"|string;
export type InsightCategoryList = InsightCategory[];
export interface InsightEvent {
/**
* A brief description of the event.
*/
Summary?: EventSummaryText;
/**
* The time, in Unix seconds, at which the event was recorded.
*/
EventTime?: Timestamp;
/**
* The impact statistics of the client side service. This includes the number of requests to the client service and whether t