Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- BatchGetTraces (Paginated)
- CreateGroup
- CreateSamplingRule
- DeleteGroup
- DeleteResourcePolicy
- DeleteSamplingRule
- GetEncryptionConfig
- GetGroup
- GetGroups (Paginated)
- GetInsight
- GetInsightEvents
- GetInsightImpactGraph
- GetInsightSummaries
- GetSamplingRules (Paginated)
- GetSamplingStatisticSummaries (Paginated)
- GetSamplingTargets
- GetServiceGraph (Paginated)
- GetTimeSeriesServiceStatistics (Paginated)
- GetTraceGraph (Paginated)
- GetTraceSummaries (Paginated)
- ListResourcePolicies (Paginated)
- ListTagsForResource (Paginated)
- PutEncryptionConfig
- PutResourcePolicy
- PutTelemetryRecords
- PutTraceSegments
- TagResource
- UntagResource
- UpdateGroup
- UpdateSamplingRule
- Types
- EncryptionStatus
- EncryptionType
- InsightCategory
- InsightState
- SamplingStrategyName
- TimeRangeType
- Alias
- AnnotationValue
- AnomalousService
- AvailabilityZoneDetail
- BackendConnectionErrors
- Edge
- EdgeStatistics
- EncryptionConfig
- ErrorRootCause
- ErrorRootCauseEntity
- ErrorRootCauseService
- ErrorStatistics
- FaultRootCause
- FaultRootCauseEntity
- FaultRootCauseService
- FaultStatistics
- ForecastStatistics
- Group
- GroupSummary
- HistogramEntry
- Http
- Insight
- InsightEvent
- InsightImpactGraphEdge
- InsightImpactGraphService
- InsightSummary
- InsightsConfiguration
- InstanceIdDetail
- RequestImpactStatistics
- ResourceARNDetail
- ResourcePolicy
- ResponseTimeRootCause
- ResponseTimeRootCauseEntity
- ResponseTimeRootCauseService
- RootCauseException
- SamplingRule
- SamplingRuleRecord
- SamplingRuleUpdate
- SamplingStatisticSummary
- SamplingStatisticsDocument
- SamplingStrategy
- SamplingTargetDocument
- Segment
- ServiceId
- ServiceInfo
- ServiceStatistics
- Tag
- TelemetryRecord
- TimeSeriesServiceStatistics
- Trace
- TraceSummary
- TraceUser
- UnprocessedStatistics
- UnprocessedTraceSegment
- ValueWithServiceIds
Derived from API version 2016-04-12
of the AWS service descriptions, licensed under Apache 2.0.
Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
Synopsis
- defaultService :: Service
- _InvalidPolicyRevisionIdException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _LockoutPreventionException :: AsError a => Fold a ServiceError
- _MalformedPolicyDocumentException :: AsError a => Fold a ServiceError
- _PolicyCountLimitExceededException :: AsError a => Fold a ServiceError
- _PolicySizeLimitExceededException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _RuleLimitExceededException :: AsError a => Fold a ServiceError
- _ThrottledException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- data BatchGetTraces = BatchGetTraces' (Maybe Text) [Text]
- newBatchGetTraces :: BatchGetTraces
- data BatchGetTracesResponse = BatchGetTracesResponse' (Maybe Text) (Maybe [Trace]) (Maybe [Text]) Int
- newBatchGetTracesResponse :: Int -> BatchGetTracesResponse
- data CreateGroup = CreateGroup' (Maybe Text) (Maybe InsightsConfiguration) (Maybe [Tag]) Text
- newCreateGroup :: Text -> CreateGroup
- data CreateGroupResponse = CreateGroupResponse' (Maybe Group) Int
- newCreateGroupResponse :: Int -> CreateGroupResponse
- data CreateSamplingRule = CreateSamplingRule' (Maybe [Tag]) SamplingRule
- newCreateSamplingRule :: SamplingRule -> CreateSamplingRule
- data CreateSamplingRuleResponse = CreateSamplingRuleResponse' (Maybe SamplingRuleRecord) Int
- newCreateSamplingRuleResponse :: Int -> CreateSamplingRuleResponse
- data DeleteGroup = DeleteGroup' (Maybe Text) (Maybe Text)
- newDeleteGroup :: DeleteGroup
- data DeleteGroupResponse = DeleteGroupResponse' Int
- newDeleteGroupResponse :: Int -> DeleteGroupResponse
- data DeleteResourcePolicy = DeleteResourcePolicy' (Maybe Text) Text
- newDeleteResourcePolicy :: Text -> DeleteResourcePolicy
- data DeleteResourcePolicyResponse = DeleteResourcePolicyResponse' Int
- newDeleteResourcePolicyResponse :: Int -> DeleteResourcePolicyResponse
- data DeleteSamplingRule = DeleteSamplingRule' (Maybe Text) (Maybe Text)
- newDeleteSamplingRule :: DeleteSamplingRule
- data DeleteSamplingRuleResponse = DeleteSamplingRuleResponse' (Maybe SamplingRuleRecord) Int
- newDeleteSamplingRuleResponse :: Int -> DeleteSamplingRuleResponse
- data GetEncryptionConfig = GetEncryptionConfig' {
- newGetEncryptionConfig :: GetEncryptionConfig
- data GetEncryptionConfigResponse = GetEncryptionConfigResponse' (Maybe EncryptionConfig) Int
- newGetEncryptionConfigResponse :: Int -> GetEncryptionConfigResponse
- data GetGroup = GetGroup' (Maybe Text) (Maybe Text)
- newGetGroup :: GetGroup
- data GetGroupResponse = GetGroupResponse' (Maybe Group) Int
- newGetGroupResponse :: Int -> GetGroupResponse
- data GetGroups = GetGroups' (Maybe Text)
- newGetGroups :: GetGroups
- data GetGroupsResponse = GetGroupsResponse' (Maybe [GroupSummary]) (Maybe Text) Int
- newGetGroupsResponse :: Int -> GetGroupsResponse
- data GetInsight = GetInsight' Text
- newGetInsight :: Text -> GetInsight
- data GetInsightResponse = GetInsightResponse' (Maybe Insight) Int
- newGetInsightResponse :: Int -> GetInsightResponse
- data GetInsightEvents = GetInsightEvents' (Maybe Natural) (Maybe Text) Text
- newGetInsightEvents :: Text -> GetInsightEvents
- data GetInsightEventsResponse = GetInsightEventsResponse' (Maybe [InsightEvent]) (Maybe Text) Int
- newGetInsightEventsResponse :: Int -> GetInsightEventsResponse
- data GetInsightImpactGraph = GetInsightImpactGraph' (Maybe Text) Text POSIX POSIX
- newGetInsightImpactGraph :: Text -> UTCTime -> UTCTime -> GetInsightImpactGraph
- data GetInsightImpactGraphResponse = GetInsightImpactGraphResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe [InsightImpactGraphService]) (Maybe POSIX) Int
- newGetInsightImpactGraphResponse :: Int -> GetInsightImpactGraphResponse
- data GetInsightSummaries = GetInsightSummaries' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe [InsightState]) POSIX POSIX
- newGetInsightSummaries :: UTCTime -> UTCTime -> GetInsightSummaries
- data GetInsightSummariesResponse = GetInsightSummariesResponse' (Maybe [InsightSummary]) (Maybe Text) Int
- newGetInsightSummariesResponse :: Int -> GetInsightSummariesResponse
- data GetSamplingRules = GetSamplingRules' (Maybe Text)
- newGetSamplingRules :: GetSamplingRules
- data GetSamplingRulesResponse = GetSamplingRulesResponse' (Maybe Text) (Maybe [SamplingRuleRecord]) Int
- newGetSamplingRulesResponse :: Int -> GetSamplingRulesResponse
- data GetSamplingStatisticSummaries = GetSamplingStatisticSummaries' (Maybe Text)
- newGetSamplingStatisticSummaries :: GetSamplingStatisticSummaries
- data GetSamplingStatisticSummariesResponse = GetSamplingStatisticSummariesResponse' (Maybe Text) (Maybe [SamplingStatisticSummary]) Int
- newGetSamplingStatisticSummariesResponse :: Int -> GetSamplingStatisticSummariesResponse
- data GetSamplingTargets = GetSamplingTargets' [SamplingStatisticsDocument]
- newGetSamplingTargets :: GetSamplingTargets
- data GetSamplingTargetsResponse = GetSamplingTargetsResponse' (Maybe POSIX) (Maybe [SamplingTargetDocument]) (Maybe [UnprocessedStatistics]) Int
- newGetSamplingTargetsResponse :: Int -> GetSamplingTargetsResponse
- data GetServiceGraph = GetServiceGraph' (Maybe Text) (Maybe Text) (Maybe Text) POSIX POSIX
- newGetServiceGraph :: UTCTime -> UTCTime -> GetServiceGraph
- data GetServiceGraphResponse = GetServiceGraphResponse' (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe [ServiceInfo]) (Maybe POSIX) Int
- newGetServiceGraphResponse :: Int -> GetServiceGraphResponse
- data GetTimeSeriesServiceStatistics = GetTimeSeriesServiceStatistics' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) POSIX POSIX
- newGetTimeSeriesServiceStatistics :: UTCTime -> UTCTime -> GetTimeSeriesServiceStatistics
- data GetTimeSeriesServiceStatisticsResponse = GetTimeSeriesServiceStatisticsResponse' (Maybe Bool) (Maybe Text) (Maybe [TimeSeriesServiceStatistics]) Int
- newGetTimeSeriesServiceStatisticsResponse :: Int -> GetTimeSeriesServiceStatisticsResponse
- data GetTraceGraph = GetTraceGraph' (Maybe Text) [Text]
- newGetTraceGraph :: GetTraceGraph
- data GetTraceGraphResponse = GetTraceGraphResponse' (Maybe Text) (Maybe [ServiceInfo]) Int
- newGetTraceGraphResponse :: Int -> GetTraceGraphResponse
- data GetTraceSummaries = GetTraceSummaries' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe SamplingStrategy) (Maybe TimeRangeType) POSIX POSIX
- newGetTraceSummaries :: UTCTime -> UTCTime -> GetTraceSummaries
- data GetTraceSummariesResponse = GetTraceSummariesResponse' (Maybe POSIX) (Maybe Text) (Maybe [TraceSummary]) (Maybe Integer) Int
- newGetTraceSummariesResponse :: Int -> GetTraceSummariesResponse
- data ListResourcePolicies = ListResourcePolicies' (Maybe Text)
- newListResourcePolicies :: ListResourcePolicies
- data ListResourcePoliciesResponse = ListResourcePoliciesResponse' (Maybe Text) (Maybe [ResourcePolicy]) Int
- newListResourcePoliciesResponse :: Int -> ListResourcePoliciesResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Text) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data PutEncryptionConfig = PutEncryptionConfig' (Maybe Text) EncryptionType
- newPutEncryptionConfig :: EncryptionType -> PutEncryptionConfig
- data PutEncryptionConfigResponse = PutEncryptionConfigResponse' (Maybe EncryptionConfig) Int
- newPutEncryptionConfigResponse :: Int -> PutEncryptionConfigResponse
- data PutResourcePolicy = PutResourcePolicy' (Maybe Bool) (Maybe Text) Text Text
- newPutResourcePolicy :: Text -> Text -> PutResourcePolicy
- data PutResourcePolicyResponse = PutResourcePolicyResponse' (Maybe ResourcePolicy) Int
- newPutResourcePolicyResponse :: Int -> PutResourcePolicyResponse
- data PutTelemetryRecords = PutTelemetryRecords' (Maybe Text) (Maybe Text) (Maybe Text) [TelemetryRecord]
- newPutTelemetryRecords :: PutTelemetryRecords
- data PutTelemetryRecordsResponse = PutTelemetryRecordsResponse' Int
- newPutTelemetryRecordsResponse :: Int -> PutTelemetryRecordsResponse
- data PutTraceSegments = PutTraceSegments' [Text]
- newPutTraceSegments :: PutTraceSegments
- data PutTraceSegmentsResponse = PutTraceSegmentsResponse' (Maybe [UnprocessedTraceSegment]) Int
- newPutTraceSegmentsResponse :: Int -> PutTraceSegmentsResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateGroup = UpdateGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InsightsConfiguration)
- newUpdateGroup :: UpdateGroup
- data UpdateGroupResponse = UpdateGroupResponse' (Maybe Group) Int
- newUpdateGroupResponse :: Int -> UpdateGroupResponse
- data UpdateSamplingRule = UpdateSamplingRule' SamplingRuleUpdate
- newUpdateSamplingRule :: SamplingRuleUpdate -> UpdateSamplingRule
- data UpdateSamplingRuleResponse = UpdateSamplingRuleResponse' (Maybe SamplingRuleRecord) Int
- newUpdateSamplingRuleResponse :: Int -> UpdateSamplingRuleResponse
- newtype EncryptionStatus where
- EncryptionStatus' { }
- pattern EncryptionStatus_ACTIVE :: EncryptionStatus
- pattern EncryptionStatus_UPDATING :: EncryptionStatus
- newtype EncryptionType where
- EncryptionType' { }
- pattern EncryptionType_KMS :: EncryptionType
- pattern EncryptionType_NONE :: EncryptionType
- newtype InsightCategory where
- InsightCategory' { }
- pattern InsightCategory_FAULT :: InsightCategory
- newtype InsightState where
- InsightState' { }
- pattern InsightState_ACTIVE :: InsightState
- pattern InsightState_CLOSED :: InsightState
- newtype SamplingStrategyName where
- newtype TimeRangeType where
- TimeRangeType' { }
- pattern TimeRangeType_Event :: TimeRangeType
- pattern TimeRangeType_TraceId :: TimeRangeType
- data Alias = Alias' (Maybe Text) (Maybe [Text]) (Maybe Text)
- newAlias :: Alias
- data AnnotationValue = AnnotationValue' (Maybe Bool) (Maybe Double) (Maybe Text)
- newAnnotationValue :: AnnotationValue
- data AnomalousService = AnomalousService' (Maybe ServiceId)
- newAnomalousService :: AnomalousService
- data AvailabilityZoneDetail = AvailabilityZoneDetail' (Maybe Text)
- newAvailabilityZoneDetail :: AvailabilityZoneDetail
- data BackendConnectionErrors = BackendConnectionErrors' (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int)
- newBackendConnectionErrors :: BackendConnectionErrors
- data Edge = Edge' (Maybe [Alias]) (Maybe Text) (Maybe POSIX) (Maybe [HistogramEntry]) (Maybe Int) (Maybe [HistogramEntry]) (Maybe POSIX) (Maybe EdgeStatistics)
- newEdge :: Edge
- data EdgeStatistics = EdgeStatistics' (Maybe ErrorStatistics) (Maybe FaultStatistics) (Maybe Integer) (Maybe Integer) (Maybe Double)
- newEdgeStatistics :: EdgeStatistics
- data EncryptionConfig = EncryptionConfig' (Maybe Text) (Maybe EncryptionStatus) (Maybe EncryptionType)
- newEncryptionConfig :: EncryptionConfig
- data ErrorRootCause = ErrorRootCause' (Maybe Bool) (Maybe [ErrorRootCauseService])
- newErrorRootCause :: ErrorRootCause
- data ErrorRootCauseEntity = ErrorRootCauseEntity' (Maybe [RootCauseException]) (Maybe Text) (Maybe Bool)
- newErrorRootCauseEntity :: ErrorRootCauseEntity
- data ErrorRootCauseService = ErrorRootCauseService' (Maybe Text) (Maybe [ErrorRootCauseEntity]) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text)
- newErrorRootCauseService :: ErrorRootCauseService
- data ErrorStatistics = ErrorStatistics' (Maybe Integer) (Maybe Integer) (Maybe Integer)
- newErrorStatistics :: ErrorStatistics
- data FaultRootCause = FaultRootCause' (Maybe Bool) (Maybe [FaultRootCauseService])
- newFaultRootCause :: FaultRootCause
- data FaultRootCauseEntity = FaultRootCauseEntity' (Maybe [RootCauseException]) (Maybe Text) (Maybe Bool)
- newFaultRootCauseEntity :: FaultRootCauseEntity
- data FaultRootCauseService = FaultRootCauseService' (Maybe Text) (Maybe [FaultRootCauseEntity]) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text)
- newFaultRootCauseService :: FaultRootCauseService
- data FaultStatistics = FaultStatistics' (Maybe Integer) (Maybe Integer)
- newFaultStatistics :: FaultStatistics
- data ForecastStatistics = ForecastStatistics' (Maybe Integer) (Maybe Integer)
- newForecastStatistics :: ForecastStatistics
- data Group = Group' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InsightsConfiguration)
- newGroup :: Group
- data GroupSummary = GroupSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InsightsConfiguration)
- newGroupSummary :: GroupSummary
- data HistogramEntry = HistogramEntry' (Maybe Int) (Maybe Double)
- newHistogramEntry :: HistogramEntry
- data Http = Http' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text)
- newHttp :: Http
- data Insight = Insight' (Maybe [InsightCategory]) (Maybe RequestImpactStatistics) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ServiceId) (Maybe RequestImpactStatistics) (Maybe POSIX) (Maybe InsightState) (Maybe Text) (Maybe [AnomalousService])
- newInsight :: Insight
- data InsightEvent = InsightEvent' (Maybe RequestImpactStatistics) (Maybe POSIX) (Maybe RequestImpactStatistics) (Maybe Text) (Maybe [AnomalousService])
- newInsightEvent :: InsightEvent
- data InsightImpactGraphEdge = InsightImpactGraphEdge' (Maybe Int)
- newInsightImpactGraphEdge :: InsightImpactGraphEdge
- data InsightImpactGraphService = InsightImpactGraphService' (Maybe Text) (Maybe [InsightImpactGraphEdge]) (Maybe Text) (Maybe [Text]) (Maybe Int) (Maybe Text)
- newInsightImpactGraphService :: InsightImpactGraphService
- data InsightSummary = InsightSummary' (Maybe [InsightCategory]) (Maybe RequestImpactStatistics) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe ServiceId) (Maybe RequestImpactStatistics) (Maybe POSIX) (Maybe InsightState) (Maybe Text) (Maybe [AnomalousService])
- newInsightSummary :: InsightSummary
- data InsightsConfiguration = InsightsConfiguration' (Maybe Bool) (Maybe Bool)
- newInsightsConfiguration :: InsightsConfiguration
- data InstanceIdDetail = InstanceIdDetail' (Maybe Text)
- newInstanceIdDetail :: InstanceIdDetail
- data RequestImpactStatistics = RequestImpactStatistics' (Maybe Integer) (Maybe Integer) (Maybe Integer)
- newRequestImpactStatistics :: RequestImpactStatistics
- data ResourceARNDetail = ResourceARNDetail' (Maybe Text)
- newResourceARNDetail :: ResourceARNDetail
- data ResourcePolicy = ResourcePolicy' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text)
- newResourcePolicy :: ResourcePolicy
- data ResponseTimeRootCause = ResponseTimeRootCause' (Maybe Bool) (Maybe [ResponseTimeRootCauseService])
- newResponseTimeRootCause :: ResponseTimeRootCause
- data ResponseTimeRootCauseEntity = ResponseTimeRootCauseEntity' (Maybe Double) (Maybe Text) (Maybe Bool)
- newResponseTimeRootCauseEntity :: ResponseTimeRootCauseEntity
- data ResponseTimeRootCauseService = ResponseTimeRootCauseService' (Maybe Text) (Maybe [ResponseTimeRootCauseEntity]) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text)
- newResponseTimeRootCauseService :: ResponseTimeRootCauseService
- data RootCauseException = RootCauseException' (Maybe Text) (Maybe Text)
- newRootCauseException :: RootCauseException
- data SamplingRule = SamplingRule' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) Text Natural Double Natural Text Text Text Text Text Natural
- newSamplingRule :: Text -> Natural -> Double -> Natural -> Text -> Text -> Text -> Text -> Text -> Natural -> SamplingRule
- data SamplingRuleRecord = SamplingRuleRecord' (Maybe POSIX) (Maybe POSIX) (Maybe SamplingRule)
- newSamplingRuleRecord :: SamplingRuleRecord
- data SamplingRuleUpdate = SamplingRuleUpdate' (Maybe (HashMap Text Text)) (Maybe Double) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newSamplingRuleUpdate :: SamplingRuleUpdate
- data SamplingStatisticSummary = SamplingStatisticSummary' (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe POSIX)
- newSamplingStatisticSummary :: SamplingStatisticSummary
- data SamplingStatisticsDocument = SamplingStatisticsDocument' (Maybe Natural) Text Text POSIX Natural Natural
- newSamplingStatisticsDocument :: Text -> Text -> UTCTime -> Natural -> Natural -> SamplingStatisticsDocument
- data SamplingStrategy = SamplingStrategy' (Maybe SamplingStrategyName) (Maybe Double)
- newSamplingStrategy :: SamplingStrategy
- data SamplingTargetDocument = SamplingTargetDocument' (Maybe Double) (Maybe Int) (Maybe Int) (Maybe POSIX) (Maybe Text)
- newSamplingTargetDocument :: SamplingTargetDocument
- data Segment = Segment' (Maybe Text) (Maybe Text)
- newSegment :: Segment
- data ServiceId = ServiceId' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text)
- newServiceId :: ServiceId
- data ServiceInfo = ServiceInfo' (Maybe Text) (Maybe [HistogramEntry]) (Maybe [Edge]) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe Int) (Maybe [HistogramEntry]) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe ServiceStatistics) (Maybe Text)
- newServiceInfo :: ServiceInfo
- data ServiceStatistics = ServiceStatistics' (Maybe ErrorStatistics) (Maybe FaultStatistics) (Maybe Integer) (Maybe Integer) (Maybe Double)
- newServiceStatistics :: ServiceStatistics
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data TelemetryRecord = TelemetryRecord' (Maybe BackendConnectionErrors) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) POSIX
- newTelemetryRecord :: UTCTime -> TelemetryRecord
- data TimeSeriesServiceStatistics = TimeSeriesServiceStatistics' (Maybe EdgeStatistics) (Maybe [HistogramEntry]) (Maybe ForecastStatistics) (Maybe ServiceStatistics) (Maybe POSIX)
- newTimeSeriesServiceStatistics :: TimeSeriesServiceStatistics
- data Trace = Trace' (Maybe Double) (Maybe Text) (Maybe Bool) (Maybe [Segment])
- newTrace :: Trace
- data TraceSummary = TraceSummary' (Maybe (HashMap Text [ValueWithServiceIds])) (Maybe [AvailabilityZoneDetail]) (Maybe Double) (Maybe ServiceId) (Maybe [ErrorRootCause]) (Maybe [FaultRootCause]) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Http) (Maybe Text) (Maybe [InstanceIdDetail]) (Maybe Bool) (Maybe POSIX) (Maybe [ResourceARNDetail]) (Maybe Double) (Maybe [ResponseTimeRootCause]) (Maybe Int) (Maybe [ServiceId]) (Maybe [TraceUser])
- newTraceSummary :: TraceSummary
- data TraceUser = TraceUser' (Maybe [ServiceId]) (Maybe Text)
- newTraceUser :: TraceUser
- data UnprocessedStatistics = UnprocessedStatistics' (Maybe Text) (Maybe Text) (Maybe Text)
- newUnprocessedStatistics :: UnprocessedStatistics
- data UnprocessedTraceSegment = UnprocessedTraceSegment' (Maybe Text) (Maybe Text) (Maybe Text)
- newUnprocessedTraceSegment :: UnprocessedTraceSegment
- data ValueWithServiceIds = ValueWithServiceIds' (Maybe AnnotationValue) (Maybe [ServiceId])
- newValueWithServiceIds :: ValueWithServiceIds
Service Configuration
defaultService :: Service Source #
API version 2016-04-12
of the Amazon X-Ray SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by XRay
.
InvalidPolicyRevisionIdException
_InvalidPolicyRevisionIdException :: AsError a => Fold a ServiceError Source #
A policy revision id was provided which does not match the latest policy
revision. This exception is also if a policy revision id of 0 is
provided via PutResourcePolicy
and a policy with the same name already
exists.
InvalidRequestException
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
The request is missing required parameters or has invalid parameters.
LockoutPreventionException
_LockoutPreventionException :: AsError a => Fold a ServiceError Source #
The provided resource policy would prevent the caller of this request from calling PutResourcePolicy in the future.
MalformedPolicyDocumentException
_MalformedPolicyDocumentException :: AsError a => Fold a ServiceError Source #
Invalid policy document provided in request.
PolicyCountLimitExceededException
_PolicyCountLimitExceededException :: AsError a => Fold a ServiceError Source #
Exceeded the maximum number of resource policies for a target Amazon Web Services account.
PolicySizeLimitExceededException
_PolicySizeLimitExceededException :: AsError a => Fold a ServiceError Source #
Exceeded the maximum size for a resource policy.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
RuleLimitExceededException
_RuleLimitExceededException :: AsError a => Fold a ServiceError Source #
You have reached the maximum number of sampling rules.
ThrottledException
_ThrottledException :: AsError a => Fold a ServiceError Source #
The request exceeds the maximum number of requests per second.
TooManyTagsException
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
You have exceeded the maximum number of tags you can apply to this resource.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BatchGetTraces (Paginated)
data BatchGetTraces Source #
See: newBatchGetTraces
smart constructor.
BatchGetTraces' (Maybe Text) [Text] |
Instances
newBatchGetTraces :: BatchGetTraces Source #
Create a value of BatchGetTraces
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchGetTraces
, batchGetTraces_nextToken
- Pagination token.
$sel:traceIds:BatchGetTraces'
, batchGetTraces_traceIds
- Specify the trace IDs of requests for which to retrieve segments.
data BatchGetTracesResponse Source #
See: newBatchGetTracesResponse
smart constructor.
Instances
newBatchGetTracesResponse Source #
Create a value of BatchGetTracesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchGetTraces
, batchGetTracesResponse_nextToken
- Pagination token.
$sel:traces:BatchGetTracesResponse'
, batchGetTracesResponse_traces
- Full traces for the specified requests.
$sel:unprocessedTraceIds:BatchGetTracesResponse'
, batchGetTracesResponse_unprocessedTraceIds
- Trace IDs of requests that haven't been processed.
BatchGetTracesResponse
, batchGetTracesResponse_httpStatus
- The response's http status code.
CreateGroup
data CreateGroup Source #
See: newCreateGroup
smart constructor.
CreateGroup' (Maybe Text) (Maybe InsightsConfiguration) (Maybe [Tag]) Text |
Instances
Create a value of CreateGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateGroup
, createGroup_filterExpression
- The filter expression defining criteria by which to group traces.
CreateGroup
, createGroup_insightsConfiguration
- 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 NotificationsEnabled 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.
$sel:tags:CreateGroup'
, createGroup_tags
- 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.
CreateGroup
, createGroup_groupName
- The case-sensitive name of the new group. Default is a reserved name and
names must be unique.
data CreateGroupResponse Source #
See: newCreateGroupResponse
smart constructor.
Instances
newCreateGroupResponse Source #
Create a value of CreateGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:group':CreateGroupResponse'
, createGroupResponse_group
- 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.
CreateGroupResponse
, createGroupResponse_httpStatus
- The response's http status code.
CreateSamplingRule
data CreateSamplingRule Source #
See: newCreateSamplingRule
smart constructor.
Instances
newCreateSamplingRule Source #
Create a value of CreateSamplingRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateSamplingRule'
, createSamplingRule_tags
- 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.
CreateSamplingRule
, createSamplingRule_samplingRule
- The rule definition.
data CreateSamplingRuleResponse Source #
See: newCreateSamplingRuleResponse
smart constructor.
Instances
newCreateSamplingRuleResponse Source #
Create a value of CreateSamplingRuleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:samplingRuleRecord:CreateSamplingRuleResponse'
, createSamplingRuleResponse_samplingRuleRecord
- The saved rule definition and metadata.
CreateSamplingRuleResponse
, createSamplingRuleResponse_httpStatus
- The response's http status code.
DeleteGroup
data DeleteGroup Source #
See: newDeleteGroup
smart constructor.
DeleteGroup' (Maybe Text) (Maybe Text) |
Instances
newDeleteGroup :: DeleteGroup Source #
Create a value of DeleteGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteGroup
, deleteGroup_groupARN
- The ARN of the group that was generated on creation.
DeleteGroup
, deleteGroup_groupName
- The case-sensitive name of the group.
data DeleteGroupResponse Source #
See: newDeleteGroupResponse
smart constructor.
Instances
newDeleteGroupResponse Source #
Create a value of DeleteGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteGroupResponse
, deleteGroupResponse_httpStatus
- The response's http status code.
DeleteResourcePolicy
data DeleteResourcePolicy Source #
See: newDeleteResourcePolicy
smart constructor.
Instances
newDeleteResourcePolicy Source #
Create a value of DeleteResourcePolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteResourcePolicy
, deleteResourcePolicy_policyRevisionId
- Specifies a specific policy revision to delete. Provide a
PolicyRevisionId
to ensure an atomic delete operation. If the provided
revision id does not match the latest policy revision id, an
InvalidPolicyRevisionIdException
exception is returned.
DeleteResourcePolicy
, deleteResourcePolicy_policyName
- The name of the resource policy to delete.
data DeleteResourcePolicyResponse Source #
See: newDeleteResourcePolicyResponse
smart constructor.
Instances
newDeleteResourcePolicyResponse Source #
Create a value of DeleteResourcePolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteResourcePolicyResponse
, deleteResourcePolicyResponse_httpStatus
- The response's http status code.
DeleteSamplingRule
data DeleteSamplingRule Source #
See: newDeleteSamplingRule
smart constructor.
Instances
newDeleteSamplingRule :: DeleteSamplingRule Source #
Create a value of DeleteSamplingRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteSamplingRule
, deleteSamplingRule_ruleARN
- The ARN of the sampling rule. Specify a rule by either name or ARN, but
not both.
DeleteSamplingRule
, deleteSamplingRule_ruleName
- The name of the sampling rule. Specify a rule by either name or ARN, but
not both.
data DeleteSamplingRuleResponse Source #
See: newDeleteSamplingRuleResponse
smart constructor.
Instances
newDeleteSamplingRuleResponse Source #
Create a value of DeleteSamplingRuleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:samplingRuleRecord:DeleteSamplingRuleResponse'
, deleteSamplingRuleResponse_samplingRuleRecord
- The deleted rule definition and metadata.
DeleteSamplingRuleResponse
, deleteSamplingRuleResponse_httpStatus
- The response's http status code.
GetEncryptionConfig
data GetEncryptionConfig Source #
See: newGetEncryptionConfig
smart constructor.
Instances
newGetEncryptionConfig :: GetEncryptionConfig Source #
Create a value of GetEncryptionConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetEncryptionConfigResponse Source #
See: newGetEncryptionConfigResponse
smart constructor.
Instances
newGetEncryptionConfigResponse Source #
Create a value of GetEncryptionConfigResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:encryptionConfig:GetEncryptionConfigResponse'
, getEncryptionConfigResponse_encryptionConfig
- The encryption configuration document.
GetEncryptionConfigResponse
, getEncryptionConfigResponse_httpStatus
- The response's http status code.
GetGroup
See: newGetGroup
smart constructor.
Instances
newGetGroup :: GetGroup Source #
Create a value of GetGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetGroup
, getGroup_groupARN
- The ARN of the group that was generated on creation.
GetGroup
, getGroup_groupName
- The case-sensitive name of the group.
data GetGroupResponse Source #
See: newGetGroupResponse
smart constructor.
Instances
Create a value of GetGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:group':GetGroupResponse'
, getGroupResponse_group
- 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.
GetGroupResponse
, getGroupResponse_httpStatus
- The response's http status code.
GetGroups (Paginated)
See: newGetGroups
smart constructor.
Instances
newGetGroups :: GetGroups Source #
Create a value of GetGroups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetGroups
, getGroups_nextToken
- Pagination token.
data GetGroupsResponse Source #
See: newGetGroupsResponse
smart constructor.
Instances
Create a value of GetGroupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groups:GetGroupsResponse'
, getGroupsResponse_groups
- The collection of all active groups.
GetGroups
, getGroupsResponse_nextToken
- Pagination token.
GetGroupsResponse
, getGroupsResponse_httpStatus
- The response's http status code.
GetInsight
data GetInsight Source #
See: newGetInsight
smart constructor.
Instances
:: Text | |
-> GetInsight |
Create a value of GetInsight
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetInsight
, getInsight_insightId
- The insight's unique identifier. Use the GetInsightSummaries action to
retrieve an InsightId.
data GetInsightResponse Source #
See: newGetInsightResponse
smart constructor.
Instances
newGetInsightResponse Source #
Create a value of GetInsightResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:insight:GetInsightResponse'
, getInsightResponse_insight
- The summary information of an insight.
GetInsightResponse
, getInsightResponse_httpStatus
- The response's http status code.
GetInsightEvents
data GetInsightEvents Source #
See: newGetInsightEvents
smart constructor.
Instances
Create a value of GetInsightEvents
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:GetInsightEvents'
, getInsightEvents_maxResults
- Used to retrieve at most the specified value of events.
GetInsightEvents
, getInsightEvents_nextToken
- Specify the pagination token returned by a previous request to retrieve
the next page of events.
GetInsightEvents
, getInsightEvents_insightId
- The insight's unique identifier. Use the GetInsightSummaries action to
retrieve an InsightId.
data GetInsightEventsResponse Source #
See: newGetInsightEventsResponse
smart constructor.
Instances
newGetInsightEventsResponse Source #
Create a value of GetInsightEventsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:insightEvents:GetInsightEventsResponse'
, getInsightEventsResponse_insightEvents
- 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.
GetInsightEvents
, getInsightEventsResponse_nextToken
- Use this token to retrieve the next page of insight events.
GetInsightEventsResponse
, getInsightEventsResponse_httpStatus
- The response's http status code.
GetInsightImpactGraph
data GetInsightImpactGraph Source #
See: newGetInsightImpactGraph
smart constructor.
Instances
newGetInsightImpactGraph Source #
:: Text | |
-> UTCTime | |
-> UTCTime | |
-> GetInsightImpactGraph |
Create a value of GetInsightImpactGraph
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetInsightImpactGraph
, getInsightImpactGraph_nextToken
- Specify the pagination token returned by a previous request to retrieve
the next page of results.
GetInsightImpactGraph
, getInsightImpactGraph_insightId
- The insight's unique identifier. Use the GetInsightSummaries action to
retrieve an InsightId.
GetInsightImpactGraph
, getInsightImpactGraph_startTime
- 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.
GetInsightImpactGraph
, getInsightImpactGraph_endTime
- 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.
data GetInsightImpactGraphResponse Source #
See: newGetInsightImpactGraphResponse
smart constructor.
GetInsightImpactGraphResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe [InsightImpactGraphService]) (Maybe POSIX) Int |
Instances
newGetInsightImpactGraphResponse Source #
Create a value of GetInsightImpactGraphResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetInsightImpactGraph
, getInsightImpactGraphResponse_endTime
- The provided end time.
GetInsightImpactGraph
, getInsightImpactGraphResponse_insightId
- The insight's unique identifier.
GetInsightImpactGraph
, getInsightImpactGraphResponse_nextToken
- Pagination token.
$sel:serviceGraphEndTime:GetInsightImpactGraphResponse'
, getInsightImpactGraphResponse_serviceGraphEndTime
- The time, in Unix seconds, at which the service graph ended.
$sel:serviceGraphStartTime:GetInsightImpactGraphResponse'
, getInsightImpactGraphResponse_serviceGraphStartTime
- The time, in Unix seconds, at which the service graph started.
GetInsightImpactGraphResponse
, getInsightImpactGraphResponse_services
- The Amazon Web Services instrumented services related to the insight.
GetInsightImpactGraph
, getInsightImpactGraphResponse_startTime
- The provided start time.
GetInsightImpactGraphResponse
, getInsightImpactGraphResponse_httpStatus
- The response's http status code.
GetInsightSummaries
data GetInsightSummaries Source #
See: newGetInsightSummaries
smart constructor.
GetInsightSummaries' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe [InsightState]) POSIX POSIX |
Instances
newGetInsightSummaries Source #
Create a value of GetInsightSummaries
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetInsightSummaries
, getInsightSummaries_groupARN
- The Amazon Resource Name (ARN) of the group. Required if the GroupName
isn't provided.
GetInsightSummaries
, getInsightSummaries_groupName
- The name of the group. Required if the GroupARN isn't provided.
$sel:maxResults:GetInsightSummaries'
, getInsightSummaries_maxResults
- The maximum number of results to display.
GetInsightSummaries
, getInsightSummaries_nextToken
- Pagination token.
$sel:states:GetInsightSummaries'
, getInsightSummaries_states
- The list of insight states.
GetInsightSummaries
, getInsightSummaries_startTime
- The beginning of the time frame in which the insights started. The start
time can't be more than 30 days old.
GetInsightSummaries
, getInsightSummaries_endTime
- The end of the time frame in which the insights ended. The end time
can't be more than 30 days old.
data GetInsightSummariesResponse Source #
See: newGetInsightSummariesResponse
smart constructor.
Instances
newGetInsightSummariesResponse Source #
Create a value of GetInsightSummariesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:insightSummaries:GetInsightSummariesResponse'
, getInsightSummariesResponse_insightSummaries
- 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.
GetInsightSummaries
, getInsightSummariesResponse_nextToken
- Pagination token.
GetInsightSummariesResponse
, getInsightSummariesResponse_httpStatus
- The response's http status code.
GetSamplingRules (Paginated)
data GetSamplingRules Source #
See: newGetSamplingRules
smart constructor.
Instances
newGetSamplingRules :: GetSamplingRules Source #
Create a value of GetSamplingRules
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSamplingRules
, getSamplingRules_nextToken
- Pagination token.
data GetSamplingRulesResponse Source #
See: newGetSamplingRulesResponse
smart constructor.
Instances
newGetSamplingRulesResponse Source #
Create a value of GetSamplingRulesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSamplingRules
, getSamplingRulesResponse_nextToken
- Pagination token.
$sel:samplingRuleRecords:GetSamplingRulesResponse'
, getSamplingRulesResponse_samplingRuleRecords
- Rule definitions and metadata.
GetSamplingRulesResponse
, getSamplingRulesResponse_httpStatus
- The response's http status code.
GetSamplingStatisticSummaries (Paginated)
data GetSamplingStatisticSummaries Source #
See: newGetSamplingStatisticSummaries
smart constructor.
Instances
newGetSamplingStatisticSummaries :: GetSamplingStatisticSummaries Source #
Create a value of GetSamplingStatisticSummaries
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSamplingStatisticSummaries
, getSamplingStatisticSummaries_nextToken
- Pagination token.
data GetSamplingStatisticSummariesResponse Source #
See: newGetSamplingStatisticSummariesResponse
smart constructor.
Instances
newGetSamplingStatisticSummariesResponse Source #
Create a value of GetSamplingStatisticSummariesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSamplingStatisticSummaries
, getSamplingStatisticSummariesResponse_nextToken
- Pagination token.
$sel:samplingStatisticSummaries:GetSamplingStatisticSummariesResponse'
, getSamplingStatisticSummariesResponse_samplingStatisticSummaries
- Information about the number of requests instrumented for each sampling
rule.
GetSamplingStatisticSummariesResponse
, getSamplingStatisticSummariesResponse_httpStatus
- The response's http status code.
GetSamplingTargets
data GetSamplingTargets Source #
See: newGetSamplingTargets
smart constructor.
Instances
newGetSamplingTargets :: GetSamplingTargets Source #
Create a value of GetSamplingTargets
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:samplingStatisticsDocuments:GetSamplingTargets'
, getSamplingTargets_samplingStatisticsDocuments
- Information about rules that the service is using to sample requests.
data GetSamplingTargetsResponse Source #
See: newGetSamplingTargetsResponse
smart constructor.
GetSamplingTargetsResponse' (Maybe POSIX) (Maybe [SamplingTargetDocument]) (Maybe [UnprocessedStatistics]) Int |
Instances
newGetSamplingTargetsResponse Source #
Create a value of GetSamplingTargetsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastRuleModification:GetSamplingTargetsResponse'
, getSamplingTargetsResponse_lastRuleModification
- 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.
$sel:samplingTargetDocuments:GetSamplingTargetsResponse'
, getSamplingTargetsResponse_samplingTargetDocuments
- Updated rules that the service should use to sample requests.
$sel:unprocessedStatistics:GetSamplingTargetsResponse'
, getSamplingTargetsResponse_unprocessedStatistics
- Information about
SamplingStatisticsDocument
that X-Ray could not process.
GetSamplingTargetsResponse
, getSamplingTargetsResponse_httpStatus
- The response's http status code.
GetServiceGraph (Paginated)
data GetServiceGraph Source #
See: newGetServiceGraph
smart constructor.
Instances
Create a value of GetServiceGraph
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetServiceGraph
, getServiceGraph_groupARN
- The Amazon Resource Name (ARN) of a group based on which you want to
generate a graph.
GetServiceGraph
, getServiceGraph_groupName
- The name of a group based on which you want to generate a graph.
GetServiceGraph
, getServiceGraph_nextToken
- Pagination token.
GetServiceGraph
, getServiceGraph_startTime
- The start of the time frame for which to generate a graph.
GetServiceGraph
, getServiceGraph_endTime
- The end of the timeframe for which to generate a graph.
data GetServiceGraphResponse Source #
See: newGetServiceGraphResponse
smart constructor.
GetServiceGraphResponse' (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe [ServiceInfo]) (Maybe POSIX) Int |
Instances
newGetServiceGraphResponse Source #
Create a value of GetServiceGraphResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containsOldGroupVersions:GetServiceGraphResponse'
, getServiceGraphResponse_containsOldGroupVersions
- 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.
GetServiceGraph
, getServiceGraphResponse_endTime
- The end of the time frame for which the graph was generated.
GetServiceGraph
, getServiceGraphResponse_nextToken
- Pagination token.
GetServiceGraphResponse
, getServiceGraphResponse_services
- The services that have processed a traced request during the specified
time frame.
GetServiceGraph
, getServiceGraphResponse_startTime
- The start of the time frame for which the graph was generated.
GetServiceGraphResponse
, getServiceGraphResponse_httpStatus
- The response's http status code.
GetTimeSeriesServiceStatistics (Paginated)
data GetTimeSeriesServiceStatistics Source #
See: newGetTimeSeriesServiceStatistics
smart constructor.
GetTimeSeriesServiceStatistics' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) POSIX POSIX |
Instances
newGetTimeSeriesServiceStatistics Source #
Create a value of GetTimeSeriesServiceStatistics
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entitySelectorExpression:GetTimeSeriesServiceStatistics'
, getTimeSeriesServiceStatistics_entitySelectorExpression
- 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.
$sel:forecastStatistics:GetTimeSeriesServiceStatistics'
, getTimeSeriesServiceStatistics_forecastStatistics
- The forecasted high and low fault count values. Forecast enabled
requests require the EntitySelectorExpression ID be provided.
GetTimeSeriesServiceStatistics
, getTimeSeriesServiceStatistics_groupARN
- The Amazon Resource Name (ARN) of the group for which to pull statistics
from.
GetTimeSeriesServiceStatistics
, getTimeSeriesServiceStatistics_groupName
- The case-sensitive name of the group for which to pull statistics from.
GetTimeSeriesServiceStatistics
, getTimeSeriesServiceStatistics_nextToken
- Pagination token.
$sel:period:GetTimeSeriesServiceStatistics'
, getTimeSeriesServiceStatistics_period
- Aggregation period in seconds.
GetTimeSeriesServiceStatistics
, getTimeSeriesServiceStatistics_startTime
- The start of the time frame for which to aggregate statistics.
GetTimeSeriesServiceStatistics
, getTimeSeriesServiceStatistics_endTime
- The end of the time frame for which to aggregate statistics.
data GetTimeSeriesServiceStatisticsResponse Source #
See: newGetTimeSeriesServiceStatisticsResponse
smart constructor.
GetTimeSeriesServiceStatisticsResponse' (Maybe Bool) (Maybe Text) (Maybe [TimeSeriesServiceStatistics]) Int |
Instances
newGetTimeSeriesServiceStatisticsResponse Source #
Create a value of GetTimeSeriesServiceStatisticsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containsOldGroupVersions:GetTimeSeriesServiceStatisticsResponse'
, getTimeSeriesServiceStatisticsResponse_containsOldGroupVersions
- 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.
GetTimeSeriesServiceStatistics
, getTimeSeriesServiceStatisticsResponse_nextToken
- Pagination token.
$sel:timeSeriesServiceStatistics:GetTimeSeriesServiceStatisticsResponse'
, getTimeSeriesServiceStatisticsResponse_timeSeriesServiceStatistics
- The collection of statistics.
GetTimeSeriesServiceStatisticsResponse
, getTimeSeriesServiceStatisticsResponse_httpStatus
- The response's http status code.
GetTraceGraph (Paginated)
data GetTraceGraph Source #
See: newGetTraceGraph
smart constructor.
GetTraceGraph' (Maybe Text) [Text] |
Instances
newGetTraceGraph :: GetTraceGraph Source #
Create a value of GetTraceGraph
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetTraceGraph
, getTraceGraph_nextToken
- Pagination token.
$sel:traceIds:GetTraceGraph'
, getTraceGraph_traceIds
- Trace IDs of requests for which to generate a service graph.
data GetTraceGraphResponse Source #
See: newGetTraceGraphResponse
smart constructor.
Instances
newGetTraceGraphResponse Source #
Create a value of GetTraceGraphResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetTraceGraph
, getTraceGraphResponse_nextToken
- Pagination token.
GetTraceGraphResponse
, getTraceGraphResponse_services
- The services that have processed one of the specified requests.
GetTraceGraphResponse
, getTraceGraphResponse_httpStatus
- The response's http status code.
GetTraceSummaries (Paginated)
data GetTraceSummaries Source #
See: newGetTraceSummaries
smart constructor.
GetTraceSummaries' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe SamplingStrategy) (Maybe TimeRangeType) POSIX POSIX |
Instances
Create a value of GetTraceSummaries
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetTraceSummaries
, getTraceSummaries_filterExpression
- Specify a filter expression to retrieve trace summaries for services or
requests that meet certain requirements.
GetTraceSummaries
, getTraceSummaries_nextToken
- Specify the pagination token returned by a previous request to retrieve
the next page of results.
$sel:sampling:GetTraceSummaries'
, getTraceSummaries_sampling
- Set to true
to get summaries for only a subset of available traces.
$sel:samplingStrategy:GetTraceSummaries'
, getTraceSummaries_samplingStrategy
- A parameter to indicate whether to enable sampling on trace summaries.
Input parameters are Name and Value.
$sel:timeRangeType:GetTraceSummaries'
, getTraceSummaries_timeRangeType
- A parameter to indicate whether to query trace summaries by TraceId or
Event time.
GetTraceSummaries
, getTraceSummaries_startTime
- The start of the time frame for which to retrieve traces.
GetTraceSummaries
, getTraceSummaries_endTime
- The end of the time frame for which to retrieve traces.
data GetTraceSummariesResponse Source #
See: newGetTraceSummariesResponse
smart constructor.
Instances
newGetTraceSummariesResponse Source #
Create a value of GetTraceSummariesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:approximateTime:GetTraceSummariesResponse'
, getTraceSummariesResponse_approximateTime
- The start time of this page of results.
GetTraceSummaries
, getTraceSummariesResponse_nextToken
- 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.
$sel:traceSummaries:GetTraceSummariesResponse'
, getTraceSummariesResponse_traceSummaries
- Trace IDs and annotations for traces that were found in the specified
time frame.
$sel:tracesProcessedCount:GetTraceSummariesResponse'
, getTraceSummariesResponse_tracesProcessedCount
- The total number of traces processed, including traces that did not
match the specified filter expression.
GetTraceSummariesResponse
, getTraceSummariesResponse_httpStatus
- The response's http status code.
ListResourcePolicies (Paginated)
data ListResourcePolicies Source #
See: newListResourcePolicies
smart constructor.
Instances
newListResourcePolicies :: ListResourcePolicies Source #
Create a value of ListResourcePolicies
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListResourcePolicies
, listResourcePolicies_nextToken
- Not currently supported.
data ListResourcePoliciesResponse Source #
See: newListResourcePoliciesResponse
smart constructor.
Instances
newListResourcePoliciesResponse Source #
Create a value of ListResourcePoliciesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListResourcePolicies
, listResourcePoliciesResponse_nextToken
- Pagination token. Not currently supported.
$sel:resourcePolicies:ListResourcePoliciesResponse'
, listResourcePoliciesResponse_resourcePolicies
- The list of resource policies in the target Amazon Web Services account.
ListResourcePoliciesResponse
, listResourcePoliciesResponse_httpStatus
- The response's http status code.
ListTagsForResource (Paginated)
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResource
, listTagsForResource_nextToken
- A pagination token. If multiple pages of results are returned, use the
NextToken
value returned with the current page of results as the value
of this parameter to get the next page of results.
ListTagsForResource
, listTagsForResource_resourceARN
- The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResource
, listTagsForResourceResponse_nextToken
- A pagination token. If multiple pages of results are returned, use the
NextToken
value returned with the current page of results to get the
next page of results.
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- A list of tags, as key and value pairs, that is associated with the
specified X-Ray group or sampling rule.
ListTagsForResourceResponse
, listTagsForResourceResponse_httpStatus
- The response's http status code.
PutEncryptionConfig
data PutEncryptionConfig Source #
See: newPutEncryptionConfig
smart constructor.
Instances
newPutEncryptionConfig Source #
Create a value of PutEncryptionConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutEncryptionConfig
, putEncryptionConfig_keyId
- An Amazon Web Services KMS key in one of the following formats:
- Alias - The name of the key. For example,
alias/MyKey
. - Key ID - The KMS key ID of the key. For example,
ae4aa6d49-a4d8-9df9-a475-4ff6d7898456
. Amazon Web Services X-Ray does not support asymmetric KMS keys. - ARN - The full Amazon Resource Name of the key ID or alias. For
example,
arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456
. Use this format to specify a key in a different account.
Omit this key if you set Type
to NONE
.
PutEncryptionConfig
, putEncryptionConfig_type
- The type of encryption. Set to KMS
to use your own key for encryption.
Set to NONE
for default encryption.
data PutEncryptionConfigResponse Source #
See: newPutEncryptionConfigResponse
smart constructor.
Instances
newPutEncryptionConfigResponse Source #
Create a value of PutEncryptionConfigResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:encryptionConfig:PutEncryptionConfigResponse'
, putEncryptionConfigResponse_encryptionConfig
- The new encryption configuration.
PutEncryptionConfigResponse
, putEncryptionConfigResponse_httpStatus
- The response's http status code.
PutResourcePolicy
data PutResourcePolicy Source #
See: newPutResourcePolicy
smart constructor.
Instances
Create a value of PutResourcePolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bypassPolicyLockoutCheck:PutResourcePolicy'
, putResourcePolicy_bypassPolicyLockoutCheck
- A flag to indicate whether to bypass the resource policy lockout safety
check.
Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.
Use this parameter only when you include a policy in the request and you
intend to prevent the principal that is making the request from making a
subsequent PutResourcePolicy
request.
The default value is false.
PutResourcePolicy
, putResourcePolicy_policyRevisionId
- Specifies a specific policy revision, to ensure an atomic create
operation. By default the resource policy is created if it does not
exist, or updated with an incremented revision id. The revision id is
unique to each policy in the account.
If the policy revision id does not match the latest revision id, the
operation will fail with an InvalidPolicyRevisionIdException
exception. You can also provide a PolicyRevisionId
of 0. In this case,
the operation will fail with an InvalidPolicyRevisionIdException
exception if a resource policy with the same name already exists.
PutResourcePolicy
, putResourcePolicy_policyName
- The name of the resource policy. Must be unique within a specific Amazon
Web Services account.
PutResourcePolicy
, putResourcePolicy_policyDocument
- The resource policy document, which can be up to 5kb in size.
data PutResourcePolicyResponse Source #
See: newPutResourcePolicyResponse
smart constructor.
Instances
newPutResourcePolicyResponse Source #
Create a value of PutResourcePolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourcePolicy:PutResourcePolicyResponse'
, putResourcePolicyResponse_resourcePolicy
- The resource policy document, as provided in the
PutResourcePolicyRequest
.
PutResourcePolicyResponse
, putResourcePolicyResponse_httpStatus
- The response's http status code.
PutTelemetryRecords
data PutTelemetryRecords Source #
See: newPutTelemetryRecords
smart constructor.
Instances
newPutTelemetryRecords :: PutTelemetryRecords Source #
Create a value of PutTelemetryRecords
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eC2InstanceId:PutTelemetryRecords'
, putTelemetryRecords_eC2InstanceId
-
$sel:hostname:PutTelemetryRecords'
, putTelemetryRecords_hostname
-
PutTelemetryRecords
, putTelemetryRecords_resourceARN
-
$sel:telemetryRecords:PutTelemetryRecords'
, putTelemetryRecords_telemetryRecords
-
data PutTelemetryRecordsResponse Source #
See: newPutTelemetryRecordsResponse
smart constructor.
Instances
newPutTelemetryRecordsResponse Source #
Create a value of PutTelemetryRecordsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutTelemetryRecordsResponse
, putTelemetryRecordsResponse_httpStatus
- The response's http status code.
PutTraceSegments
data PutTraceSegments Source #
See: newPutTraceSegments
smart constructor.
Instances
newPutTraceSegments :: PutTraceSegments Source #
Create a value of PutTraceSegments
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:traceSegmentDocuments:PutTraceSegments'
, putTraceSegments_traceSegmentDocuments
- A string containing a JSON document defining one or more segments or
subsegments.
data PutTraceSegmentsResponse Source #
See: newPutTraceSegmentsResponse
smart constructor.
Instances
newPutTraceSegmentsResponse Source #
Create a value of PutTraceSegmentsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:unprocessedTraceSegments:PutTraceSegmentsResponse'
, putTraceSegmentsResponse_unprocessedTraceSegments
- Segments that failed processing.
PutTraceSegmentsResponse
, putTraceSegmentsResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
TagResource
, tagResource_resourceARN
- The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
$sel:tags:TagResource'
, tagResource_tags
- 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
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. You cannot edit or delete system tags.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
TagResourceResponse
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UntagResource
, untagResource_resourceARN
- The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- Keys for one or more tags that you want to remove from an X-Ray group or
sampling rule.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UntagResourceResponse
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateGroup
data UpdateGroup Source #
See: newUpdateGroup
smart constructor.
Instances
newUpdateGroup :: UpdateGroup Source #
Create a value of UpdateGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateGroup
, updateGroup_filterExpression
- The updated filter expression defining criteria by which to group
traces.
UpdateGroup
, updateGroup_groupARN
- The ARN that was generated upon creation.
UpdateGroup
, updateGroup_groupName
- The case-sensitive name of the group.
UpdateGroup
, updateGroup_insightsConfiguration
- 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 for the group. Notifications can only be enabled on a group with InsightsEnabled set to true.
data UpdateGroupResponse Source #
See: newUpdateGroupResponse
smart constructor.
Instances
newUpdateGroupResponse Source #
Create a value of UpdateGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:group':UpdateGroupResponse'
, updateGroupResponse_group
- 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.
UpdateGroupResponse
, updateGroupResponse_httpStatus
- The response's http status code.
UpdateSamplingRule
data UpdateSamplingRule Source #
See: newUpdateSamplingRule
smart constructor.
Instances
newUpdateSamplingRule Source #
Create a value of UpdateSamplingRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:samplingRuleUpdate:UpdateSamplingRule'
, updateSamplingRule_samplingRuleUpdate
- The rule and fields to change.
data UpdateSamplingRuleResponse Source #
See: newUpdateSamplingRuleResponse
smart constructor.
Instances
newUpdateSamplingRuleResponse Source #
Create a value of UpdateSamplingRuleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:samplingRuleRecord:UpdateSamplingRuleResponse'
, updateSamplingRuleResponse_samplingRuleRecord
- The updated rule definition and metadata.
UpdateSamplingRuleResponse
, updateSamplingRuleResponse_httpStatus
- The response's http status code.
Types
EncryptionStatus
newtype EncryptionStatus Source #
pattern EncryptionStatus_ACTIVE :: EncryptionStatus | |
pattern EncryptionStatus_UPDATING :: EncryptionStatus |
Instances
EncryptionType
newtype EncryptionType Source #
pattern EncryptionType_KMS :: EncryptionType | |
pattern EncryptionType_NONE :: EncryptionType |
Instances
InsightCategory
newtype InsightCategory Source #
pattern InsightCategory_FAULT :: InsightCategory |
Instances
InsightState
newtype InsightState Source #
pattern InsightState_ACTIVE :: InsightState | |
pattern InsightState_CLOSED :: InsightState |
Instances
SamplingStrategyName
newtype SamplingStrategyName Source #
pattern SamplingStrategyName_FixedRate :: SamplingStrategyName | |
pattern SamplingStrategyName_PartialScan :: SamplingStrategyName |
Instances
TimeRangeType
newtype TimeRangeType Source #
pattern TimeRangeType_Event :: TimeRangeType | |
pattern TimeRangeType_TraceId :: TimeRangeType |
Instances
Alias
An alias for an edge.
See: newAlias
smart constructor.
Instances
FromJSON Alias Source # | |
Generic Alias Source # | |
Read Alias Source # | |
Show Alias Source # | |
NFData Alias Source # | |
Defined in Amazonka.XRay.Types.Alias | |
Eq Alias Source # | |
Hashable Alias Source # | |
Defined in Amazonka.XRay.Types.Alias | |
type Rep Alias Source # | |
Defined in Amazonka.XRay.Types.Alias type Rep Alias = D1 ('MetaData "Alias" "Amazonka.XRay.Types.Alias" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "Alias'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "names") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) |
Create a value of Alias
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Alias'
, alias_name
- The canonical name of the alias.
$sel:names:Alias'
, alias_names
- A list of names for the alias, including the canonical name.
$sel:type':Alias'
, alias_type
- The type of the alias.
AnnotationValue
data AnnotationValue Source #
Value of a segment annotation. Has one of three value types: Number, Boolean, or String.
See: newAnnotationValue
smart constructor.
Instances
newAnnotationValue :: AnnotationValue Source #
Create a value of AnnotationValue
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:booleanValue:AnnotationValue'
, annotationValue_booleanValue
- Value for a Boolean annotation.
$sel:numberValue:AnnotationValue'
, annotationValue_numberValue
- Value for a Number annotation.
$sel:stringValue:AnnotationValue'
, annotationValue_stringValue
- Value for a String annotation.
AnomalousService
data AnomalousService Source #
The service within the service graph that has anomalously high fault rates.
See: newAnomalousService
smart constructor.
Instances
newAnomalousService :: AnomalousService Source #
Create a value of AnomalousService
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serviceId:AnomalousService'
, anomalousService_serviceId
- Undocumented member.
AvailabilityZoneDetail
data AvailabilityZoneDetail Source #
A list of Availability Zones corresponding to the segments in a trace.
See: newAvailabilityZoneDetail
smart constructor.
Instances
newAvailabilityZoneDetail :: AvailabilityZoneDetail Source #
Create a value of AvailabilityZoneDetail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:AvailabilityZoneDetail'
, availabilityZoneDetail_name
- The name of a corresponding Availability Zone.
BackendConnectionErrors
data BackendConnectionErrors Source #
See: newBackendConnectionErrors
smart constructor.
Instances
newBackendConnectionErrors :: BackendConnectionErrors Source #
Create a value of BackendConnectionErrors
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connectionRefusedCount:BackendConnectionErrors'
, backendConnectionErrors_connectionRefusedCount
-
$sel:hTTPCode4XXCount:BackendConnectionErrors'
, backendConnectionErrors_hTTPCode4XXCount
-
$sel:hTTPCode5XXCount:BackendConnectionErrors'
, backendConnectionErrors_hTTPCode5XXCount
-
$sel:otherCount:BackendConnectionErrors'
, backendConnectionErrors_otherCount
-
$sel:timeoutCount:BackendConnectionErrors'
, backendConnectionErrors_timeoutCount
-
$sel:unknownHostCount:BackendConnectionErrors'
, backendConnectionErrors_unknownHostCount
-
Edge
Information about a connection between two services. An edge can be a synchronous connection, such as typical call between client and service, or an asynchronous link, such as a Lambda function which retrieves an event from an SNS queue.
See: newEdge
smart constructor.
Edge' (Maybe [Alias]) (Maybe Text) (Maybe POSIX) (Maybe [HistogramEntry]) (Maybe Int) (Maybe [HistogramEntry]) (Maybe POSIX) (Maybe EdgeStatistics) |
Instances
Create a value of Edge
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aliases:Edge'
, edge_aliases
- Aliases for the edge.
$sel:edgeType:Edge'
, edge_edgeType
- Describes an asynchronous connection, with a value of link
.
$sel:endTime:Edge'
, edge_endTime
- The end time of the last segment on the edge.
$sel:receivedEventAgeHistogram:Edge'
, edge_receivedEventAgeHistogram
- A histogram that maps the spread of event age when received by
consumers. Age is calculated each time an event is received. Only
populated when EdgeType is link
.
$sel:referenceId:Edge'
, edge_referenceId
- Identifier of the edge. Unique within a service map.
$sel:responseTimeHistogram:Edge'
, edge_responseTimeHistogram
- A histogram that maps the spread of client response times on an edge.
Only populated for synchronous edges.
$sel:startTime:Edge'
, edge_startTime
- The start time of the first segment on the edge.
$sel:summaryStatistics:Edge'
, edge_summaryStatistics
- Response statistics for segments on the edge.
EdgeStatistics
data EdgeStatistics Source #
Response statistics for an edge.
See: newEdgeStatistics
smart constructor.
EdgeStatistics' (Maybe ErrorStatistics) (Maybe FaultStatistics) (Maybe Integer) (Maybe Integer) (Maybe Double) |
Instances
newEdgeStatistics :: EdgeStatistics Source #
Create a value of EdgeStatistics
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorStatistics:EdgeStatistics'
, edgeStatistics_errorStatistics
- Information about requests that failed with a 4xx Client Error status
code.
$sel:faultStatistics:EdgeStatistics'
, edgeStatistics_faultStatistics
- Information about requests that failed with a 5xx Server Error status
code.
$sel:okCount:EdgeStatistics'
, edgeStatistics_okCount
- The number of requests that completed with a 2xx Success status code.
EdgeStatistics
, edgeStatistics_totalCount
- The total number of completed requests.
$sel:totalResponseTime:EdgeStatistics'
, edgeStatistics_totalResponseTime
- The aggregate response time of completed requests.
EncryptionConfig
data EncryptionConfig Source #
A configuration document that specifies encryption configuration settings.
See: newEncryptionConfig
smart constructor.
Instances
newEncryptionConfig :: EncryptionConfig Source #
Create a value of EncryptionConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:EncryptionConfig'
, encryptionConfig_keyId
- The ID of the KMS key used for encryption, if applicable.
$sel:status:EncryptionConfig'
, encryptionConfig_status
- The encryption status. While the status is UPDATING
, X-Ray may encrypt
data with a combination of the new and old settings.
$sel:type':EncryptionConfig'
, encryptionConfig_type
- The type of encryption. Set to KMS
for encryption with KMS keys. Set
to NONE
for default encryption.
ErrorRootCause
data ErrorRootCause Source #
The root cause of a trace summary error.
See: newErrorRootCause
smart constructor.
Instances
newErrorRootCause :: ErrorRootCause Source #
Create a value of ErrorRootCause
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientImpacting:ErrorRootCause'
, errorRootCause_clientImpacting
- A flag that denotes that the root cause impacts the trace client.
$sel:services:ErrorRootCause'
, errorRootCause_services
- A list of services corresponding to an error. A service identifies a
segment and it contains a name, account ID, type, and inferred flag.
ErrorRootCauseEntity
data ErrorRootCauseEntity Source #
A collection of segments and corresponding subsegments associated to a trace summary error.
See: newErrorRootCauseEntity
smart constructor.
Instances
newErrorRootCauseEntity :: ErrorRootCauseEntity Source #
Create a value of ErrorRootCauseEntity
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exceptions:ErrorRootCauseEntity'
, errorRootCauseEntity_exceptions
- The types and messages of the exceptions.
ErrorRootCauseEntity
, errorRootCauseEntity_name
- The name of the entity.
$sel:remote:ErrorRootCauseEntity'
, errorRootCauseEntity_remote
- A flag that denotes a remote subsegment.
ErrorRootCauseService
data ErrorRootCauseService Source #
A collection of fields identifying the services in a trace summary error.
See: newErrorRootCauseService
smart constructor.
ErrorRootCauseService' (Maybe Text) (Maybe [ErrorRootCauseEntity]) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) |
Instances
newErrorRootCauseService :: ErrorRootCauseService Source #
Create a value of ErrorRootCauseService
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:ErrorRootCauseService'
, errorRootCauseService_accountId
- The account ID associated to the service.
$sel:entityPath:ErrorRootCauseService'
, errorRootCauseService_entityPath
- The path of root cause entities found on the service.
$sel:inferred:ErrorRootCauseService'
, errorRootCauseService_inferred
- A Boolean value indicating if the service is inferred from the trace.
ErrorRootCauseService
, errorRootCauseService_name
- The service name.
$sel:names:ErrorRootCauseService'
, errorRootCauseService_names
- A collection of associated service names.
$sel:type':ErrorRootCauseService'
, errorRootCauseService_type
- The type associated to the service.
ErrorStatistics
data ErrorStatistics Source #
Information about requests that failed with a 4xx Client Error status code.
See: newErrorStatistics
smart constructor.
Instances
newErrorStatistics :: ErrorStatistics Source #
Create a value of ErrorStatistics
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:otherCount:ErrorStatistics'
, errorStatistics_otherCount
- The number of requests that failed with untracked 4xx Client Error
status codes.
$sel:throttleCount:ErrorStatistics'
, errorStatistics_throttleCount
- The number of requests that failed with a 419 throttling status code.
$sel:totalCount:ErrorStatistics'
, errorStatistics_totalCount
- The total number of requests that failed with a 4xx Client Error status
code.
FaultRootCause
data FaultRootCause Source #
The root cause information for a trace summary fault.
See: newFaultRootCause
smart constructor.
Instances
newFaultRootCause :: FaultRootCause Source #
Create a value of FaultRootCause
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientImpacting:FaultRootCause'
, faultRootCause_clientImpacting
- A flag that denotes that the root cause impacts the trace client.
$sel:services:FaultRootCause'
, faultRootCause_services
- A list of corresponding services. A service identifies a segment and it
contains a name, account ID, type, and inferred flag.
FaultRootCauseEntity
data FaultRootCauseEntity Source #
A collection of segments and corresponding subsegments associated to a trace summary fault error.
See: newFaultRootCauseEntity
smart constructor.
Instances
newFaultRootCauseEntity :: FaultRootCauseEntity Source #
Create a value of FaultRootCauseEntity
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exceptions:FaultRootCauseEntity'
, faultRootCauseEntity_exceptions
- The types and messages of the exceptions.
FaultRootCauseEntity
, faultRootCauseEntity_name
- The name of the entity.
$sel:remote:FaultRootCauseEntity'
, faultRootCauseEntity_remote
- A flag that denotes a remote subsegment.
FaultRootCauseService
data FaultRootCauseService Source #
A collection of fields identifying the services in a trace summary fault.
See: newFaultRootCauseService
smart constructor.
FaultRootCauseService' (Maybe Text) (Maybe [FaultRootCauseEntity]) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) |
Instances
newFaultRootCauseService :: FaultRootCauseService Source #
Create a value of FaultRootCauseService
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:FaultRootCauseService'
, faultRootCauseService_accountId
- The account ID associated to the service.
$sel:entityPath:FaultRootCauseService'
, faultRootCauseService_entityPath
- The path of root cause entities found on the service.
$sel:inferred:FaultRootCauseService'
, faultRootCauseService_inferred
- A Boolean value indicating if the service is inferred from the trace.
FaultRootCauseService
, faultRootCauseService_name
- The service name.
$sel:names:FaultRootCauseService'
, faultRootCauseService_names
- A collection of associated service names.
$sel:type':FaultRootCauseService'
, faultRootCauseService_type
- The type associated to the service.
FaultStatistics
data FaultStatistics Source #
Information about requests that failed with a 5xx Server Error status code.
See: newFaultStatistics
smart constructor.
Instances
newFaultStatistics :: FaultStatistics Source #
Create a value of FaultStatistics
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:otherCount:FaultStatistics'
, faultStatistics_otherCount
- The number of requests that failed with untracked 5xx Server Error
status codes.
$sel:totalCount:FaultStatistics'
, faultStatistics_totalCount
- The total number of requests that failed with a 5xx Server Error status
code.
ForecastStatistics
data ForecastStatistics Source #
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.
See: newForecastStatistics
smart constructor.
Instances
newForecastStatistics :: ForecastStatistics Source #
Create a value of ForecastStatistics
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:faultCountHigh:ForecastStatistics'
, forecastStatistics_faultCountHigh
- The upper limit of fault counts for a service.
$sel:faultCountLow:ForecastStatistics'
, forecastStatistics_faultCountLow
- The lower limit of fault counts for a service.
Group
Details and metadata for a group.
See: newGroup
smart constructor.
Instances
FromJSON Group Source # | |
Generic Group Source # | |
Read Group Source # | |
Show Group Source # | |
NFData Group Source # | |
Defined in Amazonka.XRay.Types.Group | |
Eq Group Source # | |
Hashable Group Source # | |
Defined in Amazonka.XRay.Types.Group | |
type Rep Group Source # | |
Defined in Amazonka.XRay.Types.Group type Rep Group = D1 ('MetaData "Group" "Amazonka.XRay.Types.Group" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "Group'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filterExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "groupARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "insightsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InsightsConfiguration))))) |
Create a value of Group
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filterExpression:Group'
, group_filterExpression
- The filter expression defining the parameters to include traces.
$sel:groupARN:Group'
, group_groupARN
- The Amazon Resource Name (ARN) of the group generated based on the
GroupName.
$sel:groupName:Group'
, group_groupName
- The unique case-sensitive name of the group.
$sel:insightsConfiguration:Group'
, group_insightsConfiguration
- 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.
GroupSummary
data GroupSummary Source #
Details for a group without metadata.
See: newGroupSummary
smart constructor.
Instances
newGroupSummary :: GroupSummary Source #
Create a value of GroupSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filterExpression:GroupSummary'
, groupSummary_filterExpression
- The filter expression defining the parameters to include traces.
$sel:groupARN:GroupSummary'
, groupSummary_groupARN
- The ARN of the group generated based on the GroupName.
$sel:groupName:GroupSummary'
, groupSummary_groupName
- The unique case-sensitive name of the group.
$sel:insightsConfiguration:GroupSummary'
, groupSummary_insightsConfiguration
- 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.
HistogramEntry
data HistogramEntry Source #
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.
See: newHistogramEntry
smart constructor.
Instances
newHistogramEntry :: HistogramEntry Source #
Create a value of HistogramEntry
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:count:HistogramEntry'
, histogramEntry_count
- The prevalence of the entry.
$sel:value:HistogramEntry'
, histogramEntry_value
- The value of the entry.
Http
Information about an HTTP request.
See: newHttp
smart constructor.
Instances
Create a value of Http
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientIp:Http'
, http_clientIp
- The IP address of the requestor.
$sel:httpMethod:Http'
, http_httpMethod
- The request method.
$sel:httpStatus:Http'
, http_httpStatus
- The response status.
$sel:httpURL:Http'
, http_httpURL
- The request URL.
$sel:userAgent:Http'
, http_userAgent
- The request's user agent string.
Insight
When fault rates go outside of the expected range, X-Ray creates an insight. Insights tracks emergent issues within your applications.
See: newInsight
smart constructor.
Insight' (Maybe [InsightCategory]) (Maybe RequestImpactStatistics) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ServiceId) (Maybe RequestImpactStatistics) (Maybe POSIX) (Maybe InsightState) (Maybe Text) (Maybe [AnomalousService]) |
Instances
newInsight :: Insight Source #
Create a value of Insight
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:categories:Insight'
, insight_categories
- The categories that label and describe the type of insight.
$sel:clientRequestImpactStatistics:Insight'
, insight_clientRequestImpactStatistics
- 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.
$sel:endTime:Insight'
, insight_endTime
- The time, in Unix seconds, at which the insight ended.
$sel:groupARN:Insight'
, insight_groupARN
- The Amazon Resource Name (ARN) of the group that the insight belongs to.
$sel:groupName:Insight'
, insight_groupName
- The name of the group that the insight belongs to.
$sel:insightId:Insight'
, insight_insightId
- The insights unique identifier.
$sel:rootCauseServiceId:Insight'
, insight_rootCauseServiceId
- Undocumented member.
$sel:rootCauseServiceRequestImpactStatistics:Insight'
, insight_rootCauseServiceRequestImpactStatistics
- 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.
$sel:startTime:Insight'
, insight_startTime
- The time, in Unix seconds, at which the insight began.
$sel:state:Insight'
, insight_state
- The current state of the insight.
$sel:summary:Insight'
, insight_summary
- A brief description of the insight.
$sel:topAnomalousServices:Insight'
, insight_topAnomalousServices
- The service within the insight that is most impacted by the incident.
InsightEvent
data InsightEvent Source #
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.
See: newInsightEvent
smart constructor.
InsightEvent' (Maybe RequestImpactStatistics) (Maybe POSIX) (Maybe RequestImpactStatistics) (Maybe Text) (Maybe [AnomalousService]) |
Instances
newInsightEvent :: InsightEvent Source #
Create a value of InsightEvent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestImpactStatistics:InsightEvent'
, insightEvent_clientRequestImpactStatistics
- 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.
$sel:eventTime:InsightEvent'
, insightEvent_eventTime
- The time, in Unix seconds, at which the event was recorded.
$sel:rootCauseServiceRequestImpactStatistics:InsightEvent'
, insightEvent_rootCauseServiceRequestImpactStatistics
- 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.
$sel:summary:InsightEvent'
, insightEvent_summary
- A brief description of the event.
$sel:topAnomalousServices:InsightEvent'
, insightEvent_topAnomalousServices
- The service during the event that is most impacted by the incident.
InsightImpactGraphEdge
data InsightImpactGraphEdge Source #
The connection between two service in an insight impact graph.
See: newInsightImpactGraphEdge
smart constructor.
Instances
newInsightImpactGraphEdge :: InsightImpactGraphEdge Source #
Create a value of InsightImpactGraphEdge
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:referenceId:InsightImpactGraphEdge'
, insightImpactGraphEdge_referenceId
- Identifier of the edge. Unique within a service map.
InsightImpactGraphService
data InsightImpactGraphService Source #
Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.
See: newInsightImpactGraphService
smart constructor.
InsightImpactGraphService' (Maybe Text) (Maybe [InsightImpactGraphEdge]) (Maybe Text) (Maybe [Text]) (Maybe Int) (Maybe Text) |
Instances
newInsightImpactGraphService :: InsightImpactGraphService Source #
Create a value of InsightImpactGraphService
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:InsightImpactGraphService'
, insightImpactGraphService_accountId
- Identifier of the Amazon Web Services account in which the service runs.
$sel:edges:InsightImpactGraphService'
, insightImpactGraphService_edges
- Connections to downstream services.
$sel:name:InsightImpactGraphService'
, insightImpactGraphService_name
- The canonical name of the service.
$sel:names:InsightImpactGraphService'
, insightImpactGraphService_names
- A list of names for the service, including the canonical name.
InsightImpactGraphService
, insightImpactGraphService_referenceId
- Identifier for the service. Unique within the service map.
$sel:type':InsightImpactGraphService'
, insightImpactGraphService_type
- Identifier for the service. Unique within the service map.
- 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.
- 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.
- 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.
- remote - A downstream service of indeterminate type.
InsightSummary
data InsightSummary Source #
Information that describes an insight.
See: newInsightSummary
smart constructor.
InsightSummary' (Maybe [InsightCategory]) (Maybe RequestImpactStatistics) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe ServiceId) (Maybe RequestImpactStatistics) (Maybe POSIX) (Maybe InsightState) (Maybe Text) (Maybe [AnomalousService]) |
Instances
newInsightSummary :: InsightSummary Source #
Create a value of InsightSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:categories:InsightSummary'
, insightSummary_categories
- Categories The categories that label and describe the type of insight.
$sel:clientRequestImpactStatistics:InsightSummary'
, insightSummary_clientRequestImpactStatistics
- 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.
$sel:endTime:InsightSummary'
, insightSummary_endTime
- The time, in Unix seconds, at which the insight ended.
$sel:groupARN:InsightSummary'
, insightSummary_groupARN
- The Amazon Resource Name (ARN) of the group that the insight belongs to.
$sel:groupName:InsightSummary'
, insightSummary_groupName
- The name of the group that the insight belongs to.
$sel:insightId:InsightSummary'
, insightSummary_insightId
- The insights unique identifier.
$sel:lastUpdateTime:InsightSummary'
, insightSummary_lastUpdateTime
- The time, in Unix seconds, that the insight was last updated.
$sel:rootCauseServiceId:InsightSummary'
, insightSummary_rootCauseServiceId
- Undocumented member.
$sel:rootCauseServiceRequestImpactStatistics:InsightSummary'
, insightSummary_rootCauseServiceRequestImpactStatistics
- 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.
$sel:startTime:InsightSummary'
, insightSummary_startTime
- The time, in Unix seconds, at which the insight began.
$sel:state:InsightSummary'
, insightSummary_state
- The current state of the insight.
$sel:summary:InsightSummary'
, insightSummary_summary
- A brief description of the insight.
$sel:topAnomalousServices:InsightSummary'
, insightSummary_topAnomalousServices
- The service within the insight that is most impacted by the incident.
InsightsConfiguration
data InsightsConfiguration Source #
The structure containing configurations related to insights.
See: newInsightsConfiguration
smart constructor.
Instances
newInsightsConfiguration :: InsightsConfiguration Source #
Create a value of InsightsConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:insightsEnabled:InsightsConfiguration'
, insightsConfiguration_insightsEnabled
- Set the InsightsEnabled value to true to enable insights or false to
disable insights.
$sel:notificationsEnabled:InsightsConfiguration'
, insightsConfiguration_notificationsEnabled
- Set the NotificationsEnabled value to true to enable insights
notifications. Notifications can only be enabled on a group with
InsightsEnabled set to true.
InstanceIdDetail
data InstanceIdDetail Source #
A list of EC2 instance IDs corresponding to the segments in a trace.
See: newInstanceIdDetail
smart constructor.
Instances
newInstanceIdDetail :: InstanceIdDetail Source #
Create a value of InstanceIdDetail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:InstanceIdDetail'
, instanceIdDetail_id
- The ID of a corresponding EC2 instance.
RequestImpactStatistics
data RequestImpactStatistics Source #
Statistics that describe how the incident has impacted a service.
See: newRequestImpactStatistics
smart constructor.
Instances
newRequestImpactStatistics :: RequestImpactStatistics Source #
Create a value of RequestImpactStatistics
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:faultCount:RequestImpactStatistics'
, requestImpactStatistics_faultCount
- The number of requests that have resulted in a fault,
$sel:okCount:RequestImpactStatistics'
, requestImpactStatistics_okCount
- The number of successful requests.
$sel:totalCount:RequestImpactStatistics'
, requestImpactStatistics_totalCount
- The total number of requests to the service.
ResourceARNDetail
data ResourceARNDetail Source #
A list of resources ARNs corresponding to the segments in a trace.
See: newResourceARNDetail
smart constructor.
Instances
newResourceARNDetail :: ResourceARNDetail Source #
Create a value of ResourceARNDetail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ResourceARNDetail'
, resourceARNDetail_arn
- The ARN of a corresponding resource.
ResourcePolicy
data ResourcePolicy Source #
A resource policy grants one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy is associated with a specific Amazon Web Services account.
See: newResourcePolicy
smart constructor.
Instances
newResourcePolicy :: ResourcePolicy Source #
Create a value of ResourcePolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastUpdatedTime:ResourcePolicy'
, resourcePolicy_lastUpdatedTime
- When the policy was last updated, in Unix time seconds.
$sel:policyDocument:ResourcePolicy'
, resourcePolicy_policyDocument
- The resource policy document, which can be up to 5kb in size.
$sel:policyName:ResourcePolicy'
, resourcePolicy_policyName
- The name of the resource policy. Must be unique within a specific Amazon
Web Services account.
$sel:policyRevisionId:ResourcePolicy'
, resourcePolicy_policyRevisionId
- Returns the current policy revision id for this policy name.
ResponseTimeRootCause
data ResponseTimeRootCause Source #
The root cause information for a response time warning.
See: newResponseTimeRootCause
smart constructor.
Instances
newResponseTimeRootCause :: ResponseTimeRootCause Source #
Create a value of ResponseTimeRootCause
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientImpacting:ResponseTimeRootCause'
, responseTimeRootCause_clientImpacting
- A flag that denotes that the root cause impacts the trace client.
$sel:services:ResponseTimeRootCause'
, responseTimeRootCause_services
- A list of corresponding services. A service identifies a segment and
contains a name, account ID, type, and inferred flag.
ResponseTimeRootCauseEntity
data ResponseTimeRootCauseEntity Source #
A collection of segments and corresponding subsegments associated to a response time warning.
See: newResponseTimeRootCauseEntity
smart constructor.
Instances
newResponseTimeRootCauseEntity :: ResponseTimeRootCauseEntity Source #
Create a value of ResponseTimeRootCauseEntity
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:coverage:ResponseTimeRootCauseEntity'
, responseTimeRootCauseEntity_coverage
- The type and messages of the exceptions.
$sel:name:ResponseTimeRootCauseEntity'
, responseTimeRootCauseEntity_name
- The name of the entity.
$sel:remote:ResponseTimeRootCauseEntity'
, responseTimeRootCauseEntity_remote
- A flag that denotes a remote subsegment.
ResponseTimeRootCauseService
data ResponseTimeRootCauseService Source #
A collection of fields identifying the service in a response time warning.
See: newResponseTimeRootCauseService
smart constructor.
ResponseTimeRootCauseService' (Maybe Text) (Maybe [ResponseTimeRootCauseEntity]) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) |
Instances
newResponseTimeRootCauseService :: ResponseTimeRootCauseService Source #
Create a value of ResponseTimeRootCauseService
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:ResponseTimeRootCauseService'
, responseTimeRootCauseService_accountId
- The account ID associated to the service.
$sel:entityPath:ResponseTimeRootCauseService'
, responseTimeRootCauseService_entityPath
- The path of root cause entities found on the service.
$sel:inferred:ResponseTimeRootCauseService'
, responseTimeRootCauseService_inferred
- A Boolean value indicating if the service is inferred from the trace.
ResponseTimeRootCauseService
, responseTimeRootCauseService_name
- The service name.
$sel:names:ResponseTimeRootCauseService'
, responseTimeRootCauseService_names
- A collection of associated service names.
$sel:type':ResponseTimeRootCauseService'
, responseTimeRootCauseService_type
- The type associated to the service.
RootCauseException
data RootCauseException Source #
The exception associated with a root cause.
See: newRootCauseException
smart constructor.
Instances
newRootCauseException :: RootCauseException Source #
Create a value of RootCauseException
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:RootCauseException'
, rootCauseException_message
- The message of the exception.
$sel:name:RootCauseException'
, rootCauseException_name
- The name of the exception.
SamplingRule
data SamplingRule Source #
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.
See: newSamplingRule
smart constructor.
SamplingRule' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) Text Natural Double Natural Text Text Text Text Text Natural |
Instances
Create a value of SamplingRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:SamplingRule'
, samplingRule_attributes
- Matches attributes derived from the request.
$sel:ruleARN:SamplingRule'
, samplingRule_ruleARN
- The ARN of the sampling rule. Specify a rule by either name or ARN, but
not both.
$sel:ruleName:SamplingRule'
, samplingRule_ruleName
- The name of the sampling rule. Specify a rule by either name or ARN, but
not both.
$sel:resourceARN:SamplingRule'
, samplingRule_resourceARN
- Matches the ARN of the Amazon Web Services resource on which the service
runs.
$sel:priority:SamplingRule'
, samplingRule_priority
- The priority of the sampling rule.
$sel:fixedRate:SamplingRule'
, samplingRule_fixedRate
- The percentage of matching requests to instrument, after the reservoir
is exhausted.
$sel:reservoirSize:SamplingRule'
, samplingRule_reservoirSize
- 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.
$sel:serviceName:SamplingRule'
, samplingRule_serviceName
- Matches the name
that the service uses to identify itself in segments.
$sel:serviceType:SamplingRule'
, samplingRule_serviceType
- Matches the origin
that the service uses to identify its type in
segments.
$sel:host:SamplingRule'
, samplingRule_host
- Matches the hostname from a request URL.
$sel:hTTPMethod:SamplingRule'
, samplingRule_hTTPMethod
- Matches the HTTP method of a request.
$sel:uRLPath:SamplingRule'
, samplingRule_uRLPath
- Matches the path from a request URL.
$sel:version:SamplingRule'
, samplingRule_version
- The version of the sampling rule format (1
).
SamplingRuleRecord
data SamplingRuleRecord Source #
A SamplingRule and its metadata.
See: newSamplingRuleRecord
smart constructor.
Instances
newSamplingRuleRecord :: SamplingRuleRecord Source #
Create a value of SamplingRuleRecord
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdAt:SamplingRuleRecord'
, samplingRuleRecord_createdAt
- When the rule was created.
$sel:modifiedAt:SamplingRuleRecord'
, samplingRuleRecord_modifiedAt
- When the rule was last modified.
$sel:samplingRule:SamplingRuleRecord'
, samplingRuleRecord_samplingRule
- The sampling rule.
SamplingRuleUpdate
data SamplingRuleUpdate Source #
A document specifying changes to a sampling rule's configuration.
See: newSamplingRuleUpdate
smart constructor.
SamplingRuleUpdate' (Maybe (HashMap Text Text)) (Maybe Double) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newSamplingRuleUpdate :: SamplingRuleUpdate Source #
Create a value of SamplingRuleUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:SamplingRuleUpdate'
, samplingRuleUpdate_attributes
- Matches attributes derived from the request.
$sel:fixedRate:SamplingRuleUpdate'
, samplingRuleUpdate_fixedRate
- The percentage of matching requests to instrument, after the reservoir
is exhausted.
$sel:hTTPMethod:SamplingRuleUpdate'
, samplingRuleUpdate_hTTPMethod
- Matches the HTTP method of a request.
$sel:host:SamplingRuleUpdate'
, samplingRuleUpdate_host
- Matches the hostname from a request URL.
$sel:priority:SamplingRuleUpdate'
, samplingRuleUpdate_priority
- The priority of the sampling rule.
$sel:reservoirSize:SamplingRuleUpdate'
, samplingRuleUpdate_reservoirSize
- 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.
$sel:resourceARN:SamplingRuleUpdate'
, samplingRuleUpdate_resourceARN
- Matches the ARN of the Amazon Web Services resource on which the service
runs.
$sel:ruleARN:SamplingRuleUpdate'
, samplingRuleUpdate_ruleARN
- The ARN of the sampling rule. Specify a rule by either name or ARN, but
not both.
$sel:ruleName:SamplingRuleUpdate'
, samplingRuleUpdate_ruleName
- The name of the sampling rule. Specify a rule by either name or ARN, but
not both.
$sel:serviceName:SamplingRuleUpdate'
, samplingRuleUpdate_serviceName
- Matches the name
that the service uses to identify itself in segments.
$sel:serviceType:SamplingRuleUpdate'
, samplingRuleUpdate_serviceType
- Matches the origin
that the service uses to identify its type in
segments.
$sel:uRLPath:SamplingRuleUpdate'
, samplingRuleUpdate_uRLPath
- Matches the path from a request URL.
SamplingStatisticSummary
data SamplingStatisticSummary Source #
Aggregated request sampling data for a sampling rule across all services for a 10-second window.
See: newSamplingStatisticSummary
smart constructor.
Instances
newSamplingStatisticSummary :: SamplingStatisticSummary Source #
Create a value of SamplingStatisticSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:borrowCount:SamplingStatisticSummary'
, samplingStatisticSummary_borrowCount
- The number of requests recorded with borrowed reservoir quota.
$sel:requestCount:SamplingStatisticSummary'
, samplingStatisticSummary_requestCount
- The number of requests that matched the rule.
$sel:ruleName:SamplingStatisticSummary'
, samplingStatisticSummary_ruleName
- The name of the sampling rule.
$sel:sampledCount:SamplingStatisticSummary'
, samplingStatisticSummary_sampledCount
- The number of requests recorded.
$sel:timestamp:SamplingStatisticSummary'
, samplingStatisticSummary_timestamp
- The start time of the reporting window.
SamplingStatisticsDocument
data SamplingStatisticsDocument Source #
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 GetSamplingTargets.
See: newSamplingStatisticsDocument
smart constructor.
Instances
newSamplingStatisticsDocument Source #
Create a value of SamplingStatisticsDocument
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:borrowCount:SamplingStatisticsDocument'
, samplingStatisticsDocument_borrowCount
- The number of requests recorded with borrowed reservoir quota.
$sel:ruleName:SamplingStatisticsDocument'
, samplingStatisticsDocument_ruleName
- The name of the sampling rule.
$sel:clientID:SamplingStatisticsDocument'
, samplingStatisticsDocument_clientID
- A unique identifier for the service in hexadecimal.
$sel:timestamp:SamplingStatisticsDocument'
, samplingStatisticsDocument_timestamp
- The current time.
$sel:requestCount:SamplingStatisticsDocument'
, samplingStatisticsDocument_requestCount
- The number of requests that matched the rule.
$sel:sampledCount:SamplingStatisticsDocument'
, samplingStatisticsDocument_sampledCount
- The number of requests recorded.
SamplingStrategy
data SamplingStrategy Source #
The name and value of a sampling rule to apply to a trace summary.
See: newSamplingStrategy
smart constructor.
Instances
newSamplingStrategy :: SamplingStrategy Source #
Create a value of SamplingStrategy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:SamplingStrategy'
, samplingStrategy_name
- The name of a sampling rule.
$sel:value:SamplingStrategy'
, samplingStrategy_value
- The value of a sampling rule.
SamplingTargetDocument
data SamplingTargetDocument Source #
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 GetSamplingTargets.
See: newSamplingTargetDocument
smart constructor.
Instances
newSamplingTargetDocument :: SamplingTargetDocument Source #
Create a value of SamplingTargetDocument
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fixedRate:SamplingTargetDocument'
, samplingTargetDocument_fixedRate
- The percentage of matching requests to instrument, after the reservoir
is exhausted.
$sel:interval:SamplingTargetDocument'
, samplingTargetDocument_interval
- The number of seconds for the service to wait before getting sampling
targets again.
$sel:reservoirQuota:SamplingTargetDocument'
, samplingTargetDocument_reservoirQuota
- The number of requests per second that X-Ray allocated for this service.
$sel:reservoirQuotaTTL:SamplingTargetDocument'
, samplingTargetDocument_reservoirQuotaTTL
- When the reservoir quota expires.
$sel:ruleName:SamplingTargetDocument'
, samplingTargetDocument_ruleName
- The name of the sampling rule.
Segment
A segment from a trace that has been ingested by the X-Ray service. The
segment can be compiled from documents uploaded with
PutTraceSegments,
or an inferred
segment for a downstream service, generated from a
subsegment sent by the service that called it.
For the full segment document schema, see Amazon Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer Guide.
See: newSegment
smart constructor.
Instances
FromJSON Segment Source # | |
Generic Segment Source # | |
Read Segment Source # | |
Show Segment Source # | |
NFData Segment Source # | |
Defined in Amazonka.XRay.Types.Segment | |
Eq Segment Source # | |
Hashable Segment Source # | |
Defined in Amazonka.XRay.Types.Segment | |
type Rep Segment Source # | |
Defined in Amazonka.XRay.Types.Segment type Rep Segment = D1 ('MetaData "Segment" "Amazonka.XRay.Types.Segment" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "Segment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "document") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newSegment :: Segment Source #
Create a value of Segment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:document:Segment'
, segment_document
- The segment document.
$sel:id:Segment'
, segment_id
- The segment's ID.
ServiceId
See: newServiceId
smart constructor.
Instances
FromJSON ServiceId Source # | |
Generic ServiceId Source # | |
Read ServiceId Source # | |
Show ServiceId Source # | |
NFData ServiceId Source # | |
Defined in Amazonka.XRay.Types.ServiceId | |
Eq ServiceId Source # | |
Hashable ServiceId Source # | |
Defined in Amazonka.XRay.Types.ServiceId | |
type Rep ServiceId Source # | |
Defined in Amazonka.XRay.Types.ServiceId type Rep ServiceId = D1 ('MetaData "ServiceId" "Amazonka.XRay.Types.ServiceId" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "ServiceId'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "names") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) |
newServiceId :: ServiceId Source #
Create a value of ServiceId
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:ServiceId'
, serviceId_accountId
-
$sel:name:ServiceId'
, serviceId_name
-
ServiceInfo
data ServiceInfo Source #
Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.
See: newServiceInfo
smart constructor.
ServiceInfo' (Maybe Text) (Maybe [HistogramEntry]) (Maybe [Edge]) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe Int) (Maybe [HistogramEntry]) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe ServiceStatistics) (Maybe Text) |
Instances
newServiceInfo :: ServiceInfo Source #
Create a value of ServiceInfo
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:ServiceInfo'
, serviceInfo_accountId
- Identifier of the Amazon Web Services account in which the service runs.
$sel:durationHistogram:ServiceInfo'
, serviceInfo_durationHistogram
- A histogram that maps the spread of service durations.
$sel:edges:ServiceInfo'
, serviceInfo_edges
- Connections to downstream services.
ServiceInfo
, serviceInfo_endTime
- The end time of the last segment that the service generated.
$sel:name:ServiceInfo'
, serviceInfo_name
- The canonical name of the service.
$sel:names:ServiceInfo'
, serviceInfo_names
- A list of names for the service, including the canonical name.
ServiceInfo
, serviceInfo_referenceId
- Identifier for the service. Unique within the service map.
ServiceInfo
, serviceInfo_responseTimeHistogram
- A histogram that maps the spread of service response times.
$sel:root:ServiceInfo'
, serviceInfo_root
- Indicates that the service was the first service to process a request.
ServiceInfo
, serviceInfo_startTime
- The start time of the first segment that the service generated.
$sel:state:ServiceInfo'
, serviceInfo_state
- The service's state.
ServiceInfo
, serviceInfo_summaryStatistics
- Aggregated statistics for the service.
$sel:type':ServiceInfo'
, serviceInfo_type
- The type of service.
- Amazon Web Services Resource - The type of an Amazon Web Services
resource. For example,
AWS::EC2::Instance
for an application running on Amazon EC2 orAWS::DynamoDB::Table
for an Amazon DynamoDB table that the application used. - 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. client
- Represents the clients that sent requests to a root service.remote
- A downstream service of indeterminate type.
ServiceStatistics
data ServiceStatistics Source #
Response statistics for a service.
See: newServiceStatistics
smart constructor.
ServiceStatistics' (Maybe ErrorStatistics) (Maybe FaultStatistics) (Maybe Integer) (Maybe Integer) (Maybe Double) |
Instances
newServiceStatistics :: ServiceStatistics Source #
Create a value of ServiceStatistics
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorStatistics:ServiceStatistics'
, serviceStatistics_errorStatistics
- Information about requests that failed with a 4xx Client Error status
code.
$sel:faultStatistics:ServiceStatistics'
, serviceStatistics_faultStatistics
- Information about requests that failed with a 5xx Server Error status
code.
$sel:okCount:ServiceStatistics'
, serviceStatistics_okCount
- The number of requests that completed with a 2xx Success status code.
ServiceStatistics
, serviceStatistics_totalCount
- The total number of completed requests.
$sel:totalResponseTime:ServiceStatistics'
, serviceStatistics_totalResponseTime
- The aggregate response time of completed requests.
Tag
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 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
- Tag keys and values are case sensitive.
- Don't use
aws:
as a prefix for keys; it's reserved for Amazon Web Services use. You cannot edit or delete system tags.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.XRay.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.XRay.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.XRay.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.XRay.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.XRay.Types.Tag" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag'
, tag_key
- A tag key, such as Stage
or Name
. 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:
+ - = . _ : /
$sel:value:Tag'
, tag_value
- An optional tag value, such as Production
or test-only
. The value
can be a maximum of 255 characters, and contain only Unicode letters,
numbers, or separators, or the following special characters:
+ - = . _ : /
TelemetryRecord
data TelemetryRecord Source #
See: newTelemetryRecord
smart constructor.
TelemetryRecord' (Maybe BackendConnectionErrors) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) POSIX |
Instances
Create a value of TelemetryRecord
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backendConnectionErrors:TelemetryRecord'
, telemetryRecord_backendConnectionErrors
-
$sel:segmentsReceivedCount:TelemetryRecord'
, telemetryRecord_segmentsReceivedCount
-
$sel:segmentsRejectedCount:TelemetryRecord'
, telemetryRecord_segmentsRejectedCount
-
$sel:segmentsSentCount:TelemetryRecord'
, telemetryRecord_segmentsSentCount
-
$sel:segmentsSpilloverCount:TelemetryRecord'
, telemetryRecord_segmentsSpilloverCount
-
$sel:timestamp:TelemetryRecord'
, telemetryRecord_timestamp
-
TimeSeriesServiceStatistics
data TimeSeriesServiceStatistics Source #
A list of TimeSeriesStatistic structures.
See: newTimeSeriesServiceStatistics
smart constructor.
TimeSeriesServiceStatistics' (Maybe EdgeStatistics) (Maybe [HistogramEntry]) (Maybe ForecastStatistics) (Maybe ServiceStatistics) (Maybe POSIX) |
Instances
newTimeSeriesServiceStatistics :: TimeSeriesServiceStatistics Source #
Create a value of TimeSeriesServiceStatistics
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:edgeSummaryStatistics:TimeSeriesServiceStatistics'
, timeSeriesServiceStatistics_edgeSummaryStatistics
- Undocumented member.
$sel:responseTimeHistogram:TimeSeriesServiceStatistics'
, timeSeriesServiceStatistics_responseTimeHistogram
- The response time histogram for the selected entities.
$sel:serviceForecastStatistics:TimeSeriesServiceStatistics'
, timeSeriesServiceStatistics_serviceForecastStatistics
- The forecasted high and low fault count values.
$sel:serviceSummaryStatistics:TimeSeriesServiceStatistics'
, timeSeriesServiceStatistics_serviceSummaryStatistics
- Undocumented member.
$sel:timestamp:TimeSeriesServiceStatistics'
, timeSeriesServiceStatistics_timestamp
- Timestamp of the window for which statistics are aggregated.
Trace
A collection of segment documents with matching trace IDs.
See: newTrace
smart constructor.
Instances
FromJSON Trace Source # | |
Generic Trace Source # | |
Read Trace Source # | |
Show Trace Source # | |
NFData Trace Source # | |
Defined in Amazonka.XRay.Types.Trace | |
Eq Trace Source # | |
Hashable Trace Source # | |
Defined in Amazonka.XRay.Types.Trace | |
type Rep Trace Source # | |
Defined in Amazonka.XRay.Types.Trace type Rep Trace = D1 ('MetaData "Trace" "Amazonka.XRay.Types.Trace" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "Trace'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "limitExceeded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "segments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Segment]))))) |
Create a value of Trace
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:duration:Trace'
, trace_duration
- The length of time in seconds between the start time of the root segment
and the end time of the last segment that completed.
Trace
, trace_id
- The unique identifier for the request that generated the trace's
segments and subsegments.
$sel:limitExceeded:Trace'
, trace_limitExceeded
- LimitExceeded is set to true when the trace has exceeded the
Trace document size
limit. For more information about this limit and
other X-Ray limits and quotas, see
Amazon Web Services X-Ray endpoints and quotas.
$sel:segments:Trace'
, trace_segments
- Segment documents for the segments and subsegments that comprise the
trace.
TraceSummary
data TraceSummary Source #
Metadata generated from the segment documents in a trace.
See: newTraceSummary
smart constructor.
TraceSummary' (Maybe (HashMap Text [ValueWithServiceIds])) (Maybe [AvailabilityZoneDetail]) (Maybe Double) (Maybe ServiceId) (Maybe [ErrorRootCause]) (Maybe [FaultRootCause]) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Http) (Maybe Text) (Maybe [InstanceIdDetail]) (Maybe Bool) (Maybe POSIX) (Maybe [ResourceARNDetail]) (Maybe Double) (Maybe [ResponseTimeRootCause]) (Maybe Int) (Maybe [ServiceId]) (Maybe [TraceUser]) |
Instances
newTraceSummary :: TraceSummary Source #
Create a value of TraceSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:annotations:TraceSummary'
, traceSummary_annotations
- Annotations from the trace's segment documents.
$sel:availabilityZones:TraceSummary'
, traceSummary_availabilityZones
- A list of Availability Zones for any zone corresponding to the trace
segments.
$sel:duration:TraceSummary'
, traceSummary_duration
- The length of time in seconds between the start time of the root segment
and the end time of the last segment that completed.
$sel:entryPoint:TraceSummary'
, traceSummary_entryPoint
- The root of a trace.
$sel:errorRootCauses:TraceSummary'
, traceSummary_errorRootCauses
- A collection of ErrorRootCause structures corresponding to the trace
segments.
$sel:faultRootCauses:TraceSummary'
, traceSummary_faultRootCauses
- A collection of FaultRootCause structures corresponding to the trace
segments.
$sel:hasError:TraceSummary'
, traceSummary_hasError
- The root segment document has a 400 series error.
$sel:hasFault:TraceSummary'
, traceSummary_hasFault
- The root segment document has a 500 series error.
$sel:hasThrottle:TraceSummary'
, traceSummary_hasThrottle
- One or more of the segment documents has a 429 throttling error.
$sel:http:TraceSummary'
, traceSummary_http
- Information about the HTTP request served by the trace.
TraceSummary
, traceSummary_id
- The unique identifier for the request that generated the trace's
segments and subsegments.
$sel:instanceIds:TraceSummary'
, traceSummary_instanceIds
- A list of EC2 instance IDs for any instance corresponding to the trace
segments.
$sel:isPartial:TraceSummary'
, traceSummary_isPartial
- One or more of the segment documents is in progress.
$sel:matchedEventTime:TraceSummary'
, traceSummary_matchedEventTime
- The matched time stamp of a defined event.
$sel:resourceARNs:TraceSummary'
, traceSummary_resourceARNs
- A list of resource ARNs for any resource corresponding to the trace
segments.
$sel:responseTime:TraceSummary'
, traceSummary_responseTime
- 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.
$sel:responseTimeRootCauses:TraceSummary'
, traceSummary_responseTimeRootCauses
- A collection of ResponseTimeRootCause structures corresponding to the
trace segments.
$sel:revision:TraceSummary'
, traceSummary_revision
- The revision number of a trace.
TraceSummary
, traceSummary_serviceIds
- Service IDs from the trace's segment documents.
$sel:users:TraceSummary'
, traceSummary_users
- Users from the trace's segment documents.
TraceUser
Information about a user recorded in segment documents.
See: newTraceUser
smart constructor.
TraceUser' (Maybe [ServiceId]) (Maybe Text) |
Instances
FromJSON TraceUser Source # | |
Generic TraceUser Source # | |
Read TraceUser Source # | |
Show TraceUser Source # | |
NFData TraceUser Source # | |
Defined in Amazonka.XRay.Types.TraceUser | |
Eq TraceUser Source # | |
Hashable TraceUser Source # | |
Defined in Amazonka.XRay.Types.TraceUser | |
type Rep TraceUser Source # | |
Defined in Amazonka.XRay.Types.TraceUser type Rep TraceUser = D1 ('MetaData "TraceUser" "Amazonka.XRay.Types.TraceUser" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "TraceUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serviceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ServiceId])) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newTraceUser :: TraceUser Source #
Create a value of TraceUser
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serviceIds:TraceUser'
, traceUser_serviceIds
- Services that the user's request hit.
$sel:userName:TraceUser'
, traceUser_userName
- The user's name.
UnprocessedStatistics
data UnprocessedStatistics Source #
Sampling statistics from a call to GetSamplingTargets that X-Ray could not process.
See: newUnprocessedStatistics
smart constructor.
Instances
newUnprocessedStatistics :: UnprocessedStatistics Source #
Create a value of UnprocessedStatistics
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:UnprocessedStatistics'
, unprocessedStatistics_errorCode
- The error code.
$sel:message:UnprocessedStatistics'
, unprocessedStatistics_message
- The error message.
$sel:ruleName:UnprocessedStatistics'
, unprocessedStatistics_ruleName
- The name of the sampling rule.
UnprocessedTraceSegment
data UnprocessedTraceSegment Source #
Information about a segment that failed processing.
See: newUnprocessedTraceSegment
smart constructor.
Instances
newUnprocessedTraceSegment :: UnprocessedTraceSegment Source #
Create a value of UnprocessedTraceSegment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:UnprocessedTraceSegment'
, unprocessedTraceSegment_errorCode
- The error that caused processing to fail.
$sel:id:UnprocessedTraceSegment'
, unprocessedTraceSegment_id
- The segment's ID.
$sel:message:UnprocessedTraceSegment'
, unprocessedTraceSegment_message
- The error message.
ValueWithServiceIds
data ValueWithServiceIds Source #
Information about a segment annotation.
See: newValueWithServiceIds
smart constructor.
Instances
newValueWithServiceIds :: ValueWithServiceIds Source #
Create a value of ValueWithServiceIds
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:annotationValue:ValueWithServiceIds'
, valueWithServiceIds_annotationValue
- Values of the annotation.
$sel:serviceIds:ValueWithServiceIds'
, valueWithServiceIds_serviceIds
- Services to which the annotation applies.